From e84d4ab775fa0e1206aece5f096353466320d622 Mon Sep 17 00:00:00 2001 From: Chris Moesel Date: Mon, 15 May 2023 12:25:48 -0400 Subject: [PATCH] SUSHI 2.x: Use R5 5.0.0 for cross-version (implied) extensions (#1277) * Use R5 5.0.0 for cross-version (implied) extensions (#1276) (cherry picked from commit 2b31b9206020c7ff424a9bc1b09be1ed0b545e4b) * Fix remaining issues for replacing R5 current w/ 5.0.0 --- src/fhirdefs/impliedExtensions.ts | 2 +- src/utils/Processing.ts | 2 +- test/export/InstanceExporter.test.ts | 2 +- .../StructureDefinitionExporter.test.ts | 2 +- test/fhirdefs/FHIRDefinitions.test.ts | 6 +- test/fhirdefs/impliedExtension.test.ts | 25 +- test/fhirdefs/load.test.ts | 15 +- .../ElementDefinition.bindToVS.test.ts | 2 +- .../ElementDefinition.constrainType.test.ts | 2 +- .../CodeSystem-guide-parameter-code.json | 86 +- .../package/StructureDefinition-CarePlan.json | 3768 +--------------- ...StructureDefinition-CodeableReference.json | 252 +- .../StructureDefinition-Condition.json | 2543 +---------- .../StructureDefinition-DomainResource.json | 2 +- .../StructureDefinition-Extension.json | 596 +-- .../package/StructureDefinition-Group.json | 1713 +------ ...StructureDefinition-MedicationRequest.json | 3968 +---------------- .../StructureDefinition-Observation.json | 2 +- .../StructureDefinition-Organization.json | 2 +- .../package/StructureDefinition-Patient.json | 2 +- .../StructureDefinition-Practitioner.json | 2 +- .../package/StructureDefinition-Resource.json | 2 +- .../StructureDefinition-Signature.json | 563 +-- ...ructureDefinition-StructureDefinition.json | 3265 +------------- .../StructureDefinition-actualgroup.json | 1288 +----- .../StructureDefinition-bodyheight.json | 3931 +--------------- .../StructureDefinition-bodyweight.json | 3931 +--------------- .../package/StructureDefinition-string.json | 182 +- .../package/StructureDefinition-uri.json | 180 +- .../StructureDefinition-vitalsigns.json | 3268 +------------- test/utils/Processing.test.ts | 2 +- 31 files changed, 56 insertions(+), 29550 deletions(-) diff --git a/src/fhirdefs/impliedExtensions.ts b/src/fhirdefs/impliedExtensions.ts index b19d980b0..91b0605f2 100644 --- a/src/fhirdefs/impliedExtensions.ts +++ b/src/fhirdefs/impliedExtensions.ts @@ -38,7 +38,7 @@ const VERSION_TO_PACKAGE_MAP: { [key: string]: string } = { '1.0': 'hl7.fhir.r2.core#1.0.2', '3.0': 'hl7.fhir.r3.core#3.0.2', '4.0': 'hl7.fhir.r4.core#4.0.1', - '5.0': 'hl7.fhir.r5.core#current' + '5.0': 'hl7.fhir.r5.core#5.0.0' }; // This map represents how old resource types (R2/R3) map to R4/R5 or how new resource types (R5) map to R4. diff --git a/src/utils/Processing.ts b/src/utils/Processing.ts index 4f2811cba..fec50b121 100644 --- a/src/utils/Processing.ts +++ b/src/utils/Processing.ts @@ -25,7 +25,7 @@ const EXT_PKG_TO_FHIR_PKG_MAP: { [key: string]: string } = { 'hl7.fhir.extensions.r2': 'hl7.fhir.r2.core#1.0.2', 'hl7.fhir.extensions.r3': 'hl7.fhir.r3.core#3.0.2', 'hl7.fhir.extensions.r4': 'hl7.fhir.r4.core#4.0.1', - 'hl7.fhir.extensions.r5': 'hl7.fhir.r5.core#current' + 'hl7.fhir.extensions.r5': 'hl7.fhir.r5.core#5.0.0' }; const CERTIFICATE_MESSAGE = diff --git a/test/export/InstanceExporter.test.ts b/test/export/InstanceExporter.test.ts index 8af14e468..17371eaa7 100644 --- a/test/export/InstanceExporter.test.ts +++ b/test/export/InstanceExporter.test.ts @@ -5263,7 +5263,7 @@ describe('InstanceExporter R5', () => { doc = new FSHDocument('fileName'); const input = new FSHTank([doc], minimalConfig); const pkg = new Package(input.config); - const fisher = new TestFisher(input, defs, pkg, 'hl7.fhir.r5.core#current', 'r5-definitions'); + const fisher = new TestFisher(input, defs, pkg, 'hl7.fhir.r5.core#5.0.0', 'r5-definitions'); sdExporter = new StructureDefinitionExporter(input, pkg, fisher); exporter = new InstanceExporter(input, pkg, fisher); exportInstance = (instance: Instance) => { diff --git a/test/export/StructureDefinitionExporter.test.ts b/test/export/StructureDefinitionExporter.test.ts index c8f724f2c..c4c49503b 100644 --- a/test/export/StructureDefinitionExporter.test.ts +++ b/test/export/StructureDefinitionExporter.test.ts @@ -8174,7 +8174,7 @@ describe('StructureDefinitionExporter R5', () => { doc = new FSHDocument('fileName'); const input = new FSHTank([doc], minimalConfig); pkg = new Package(input.config); - const fisher = new TestFisher(input, defs, pkg, 'hl7.fhir.r5.core#current', 'r5-definitions'); + const fisher = new TestFisher(input, defs, pkg, 'hl7.fhir.r5.core#5.0.0', 'r5-definitions'); exporter = new StructureDefinitionExporter(input, pkg, fisher); loggerSpy.reset(); }); diff --git a/test/fhirdefs/FHIRDefinitions.test.ts b/test/fhirdefs/FHIRDefinitions.test.ts index fb270e21c..c1b1ac9bc 100644 --- a/test/fhirdefs/FHIRDefinitions.test.ts +++ b/test/fhirdefs/FHIRDefinitions.test.ts @@ -911,12 +911,12 @@ describe('FHIRDefinitions', () => { const r3 = new FHIRDefinitions(true); r3.packages.push('hl7.fhir.r3.core#3.0.2'); const r5 = new FHIRDefinitions(true); - r5.packages.push('hl7.fhir.r5.core#current'); + r5.packages.push('hl7.fhir.r5.core#5.0.0'); defs.addSupplementalFHIRDefinitions('hl7.fhir.r3.core#3.0.2', r3); - defs.addSupplementalFHIRDefinitions('hl7.fhir.r5.core#current', r5); + defs.addSupplementalFHIRDefinitions('hl7.fhir.r5.core#5.0.0', r5); expect(defs.supplementalFHIRPackages).toEqual([ 'hl7.fhir.r3.core#3.0.2', - 'hl7.fhir.r5.core#current' + 'hl7.fhir.r5.core#5.0.0' ]); }); }); diff --git a/test/fhirdefs/impliedExtension.test.ts b/test/fhirdefs/impliedExtension.test.ts index e0f9f1483..e9f78af19 100644 --- a/test/fhirdefs/impliedExtension.test.ts +++ b/test/fhirdefs/impliedExtension.test.ts @@ -52,7 +52,7 @@ describe('impliedExtensions', () => { defs.addSupplementalFHIRDefinitions('hl7.fhir.r3.core#3.0.2', r3Defs); const r5Defs = new FHIRDefinitions(true); loadFromPath(path.join(__dirname, '..', 'testhelpers', 'testdefs'), 'r5-definitions', r5Defs); - defs.addSupplementalFHIRDefinitions('hl7.fhir.r5.core#current', r5Defs); + defs.addSupplementalFHIRDefinitions('hl7.fhir.r5.core#5.0.0', r5Defs); loggerSpy.reset(); }); @@ -694,7 +694,7 @@ describe('impliedExtensions', () => { resourceType: 'StructureDefinition', id: 'extension-MedicationRequest.informationSource', url: 'http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.informationSource', - version: '4.6.0', + version: '5.0.0', name: 'Extension_MedicationRequest_informationSource', title: 'Implied extension for MedicationRequest.informationSource', status: 'active', @@ -718,8 +718,7 @@ describe('impliedExtensions', () => { definition: 'The person or organization who provided the information about this request, if the ' + 'source is someone other than the requestor. This is often used when the ' + - 'MedicationRequest is reported by another person.', - max: '1' + 'MedicationRequest is reported by another person.' }); const snapRoot = ext.snapshot?.element?.[0]; expect(snapRoot).toMatchObject(diffRoot); @@ -781,7 +780,7 @@ describe('impliedExtensions', () => { resourceType: 'StructureDefinition', id: 'extension-MedicationRequest.substitution', url: 'http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.substitution', - version: '4.6.0', + version: '5.0.0', name: 'Extension_MedicationRequest_substitution', title: 'Implied extension for MedicationRequest.substitution', status: 'active', @@ -893,7 +892,7 @@ describe('impliedExtensions', () => { type: [{ code: 'boolean' }, { code: 'CodeableConcept' }], binding: { description: 'Identifies the type of substitution allowed.', - strength: 'example', + strength: 'preferred', valueSet: 'http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode' } }); @@ -966,7 +965,7 @@ describe('impliedExtensions', () => { resourceType: 'StructureDefinition', id: 'extension-MedicationRequest.medication', url: 'http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationRequest.medication', - version: '4.6.0', + version: '5.0.0', name: 'Extension_MedicationRequest_medication', title: 'Implied extension for MedicationRequest.medication', status: 'active', @@ -1046,8 +1045,8 @@ describe('impliedExtensions', () => { sliceName: 'concept', short: 'Reference to a concept (by class)', definition: - "A reference to a concept - e.g. the information is identified by it's general " + - 'classto the degree of precision found in the terminology.', + 'A reference to a concept - e.g. the information is identified by its general ' + + 'class to the degree of precision found in the terminology.', min: 0, max: '1', type: [{ code: 'Extension' }] @@ -1332,7 +1331,7 @@ describe('impliedExtensions', () => { ) ).toBeUndefined(); expect(loggerSpy.getLastMessage('error')).toMatch( - /The extension http:\/\/hl7\.org\/fhir\/3\.0\/StructureDefinition\/extension-Patient\.animal\.species requires .*\n.*hl7\.fhir\.extensions\.r3: 4\.6\.0/ + /The extension http:\/\/hl7\.org\/fhir\/3\.0\/StructureDefinition\/extension-Patient\.animal\.species requires .*\n.*hl7\.fhir\.extensions\.r3: 5\.0\.0/ ); }); @@ -1353,7 +1352,7 @@ describe('impliedExtensions', () => { title: 'Implied extension for Bundle.timestamp', status: 'active', description: 'Implied extension for Bundle.timestamp', - fhirVersion: '4.6.0', + fhirVersion: '5.0.0', kind: 'complex-type', abstract: false, context: [{ type: 'element', expression: 'Element' }], @@ -1470,7 +1469,7 @@ describe('impliedExtensions', () => { title: 'Implied extension for Bundle.signature', status: 'active', description: 'Implied extension for Bundle.signature', - fhirVersion: '4.6.0', + fhirVersion: '5.0.0', kind: 'complex-type', abstract: false, context: [{ type: 'element', expression: 'Element' }], @@ -1553,7 +1552,7 @@ describe('impliedExtensions', () => { title: 'Implied extension for Bundle.link', status: 'active', description: 'Implied extension for Bundle.link', - fhirVersion: '4.6.0', + fhirVersion: '5.0.0', kind: 'complex-type', abstract: false, context: [{ type: 'element', expression: 'Element' }], diff --git a/test/fhirdefs/load.test.ts b/test/fhirdefs/load.test.ts index f41e15155..67b01dd93 100644 --- a/test/fhirdefs/load.test.ts +++ b/test/fhirdefs/load.test.ts @@ -207,6 +207,7 @@ describe('#loadDependency()', () => { uri === 'https://packages.fhir.org/hl7.fhir.r4b.core/4.3.0' || uri === 'https://packages2.fhir.org/packages/hl7.fhir.r5.core/4.5.0' || uri === 'https://packages.fhir.org/hl7.fhir.r4.core/4.0.1' || + uri === 'https://packages.fhir.org/hl7.fhir.r5.core/5.0.0' || uri === 'https://packages2.fhir.org/packages/fhir.dicom/2021.4.20210910' ) { return { @@ -321,6 +322,16 @@ describe('#loadDependency()', () => { ); }); + it('should try to load FHIR R5 (5.0.0) from packages.fhir.org when it is not cached', async () => { + await expect(loadDependency('hl7.fhir.r5.core', '5.0.0', defs, 'foo')).rejects.toThrow( + 'The package hl7.fhir.r5.core#5.0.0 could not be loaded locally or from the FHIR package registry' + ); // the package is never actually added to the cache, since tar is mocked + expectDownloadSequence( + 'https://packages.fhir.org/hl7.fhir.r5.core/5.0.0', + path.join('foo', 'hl7.fhir.r5.core#5.0.0') + ); + }); + it('should try to load a package from packages2.fhir.org when it is not on packages.fhir.org', async () => { await expect(loadDependency('fhir.dicom', '2021.4.20210910', defs, 'foo')).rejects.toThrow( 'The package fhir.dicom#2021.4.20210910 could not be loaded locally or from the FHIR package registry' @@ -724,7 +735,7 @@ describe('#loadSupplementalFHIRPackage()', () => { const promises = [ 'hl7.fhir.r2.core#1.0.2', 'hl7.fhir.r3.core#3.0.2', - 'hl7.fhir.r5.core#current' + 'hl7.fhir.r5.core#5.0.0' ].map(version => { return loadSupplementalFHIRPackage(version, defs); }); @@ -734,7 +745,7 @@ describe('#loadSupplementalFHIRPackage()', () => { expect(defs.supplementalFHIRPackages).toEqual([ 'hl7.fhir.r2.core#1.0.2', 'hl7.fhir.r3.core#3.0.2', - 'hl7.fhir.r5.core#current' + 'hl7.fhir.r5.core#5.0.0' ]); expect(defs.isSupplementalFHIRDefinitions).toBeFalsy(); expect(loggerSpy.getAllLogs('error')).toHaveLength(0); diff --git a/test/fhirtypes/ElementDefinition.bindToVS.test.ts b/test/fhirtypes/ElementDefinition.bindToVS.test.ts index 5cdf2da4c..a2f53a34c 100644 --- a/test/fhirtypes/ElementDefinition.bindToVS.test.ts +++ b/test/fhirtypes/ElementDefinition.bindToVS.test.ts @@ -188,7 +188,7 @@ describe('ElementDefinition R5', () => { loadFromPath(path.join(__dirname, '..', 'testhelpers', 'testdefs'), 'r5-definitions', defs); fisher = new TestFisher() .withFHIR(defs) - .withCachePackageName('hl7.fhir.r5.core#current') + .withCachePackageName('hl7.fhir.r5.core#5.0.0') .withTestPackageName('r5-definitions'); }); beforeEach(() => { diff --git a/test/fhirtypes/ElementDefinition.constrainType.test.ts b/test/fhirtypes/ElementDefinition.constrainType.test.ts index f3d38e0c8..4195b2079 100644 --- a/test/fhirtypes/ElementDefinition.constrainType.test.ts +++ b/test/fhirtypes/ElementDefinition.constrainType.test.ts @@ -1201,7 +1201,7 @@ describe('ElementDefinition R5', () => { fisher = new TestFisher() .withFHIR(defs) .withPackage(pkg) - .withCachePackageName('hl7.fhir.r5.core#current') + .withCachePackageName('hl7.fhir.r5.core#5.0.0') .withTestPackageName('r5-definitions'); }); diff --git a/test/testhelpers/testdefs/r5-definitions/package/CodeSystem-guide-parameter-code.json b/test/testhelpers/testdefs/r5-definitions/package/CodeSystem-guide-parameter-code.json index 651b1ea22..d0ed18e99 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/CodeSystem-guide-parameter-code.json +++ b/test/testhelpers/testdefs/r5-definitions/package/CodeSystem-guide-parameter-code.json @@ -1,85 +1 @@ -{ - "resourceType": "CodeSystem", - "id": "guide-parameter-code", - "meta": { - "lastUpdated": "2022-09-10T04:52:37.223+10:00", - "profile": [ - "http://hl7.org/fhir/StructureDefinition/shareablecodesystem" - ] - }, - "text": { - "status": "generated", - "div": "
\n

This code system \n http://hl7.org/fhir/guide-parameter-code defines the following codes:\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Code\n \n Display\n \n Definition\n
apply\n \n Apply Metadata ValueIf the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.
path-resource\n \n Resource PathThe value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type.
path-pages\n \n Pages PathThe value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.
path-tx-cache\n \n Terminology Cache PathThe value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control.
expansion-parameter\n \n Expansion ProfileThe value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT.
rule-broken-links\n \n Broken Links RuleThe value of this string 0..1 parameter is either "warning" or "error" (default = "error"). If the value is "warning" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.
generate-xml\n \n Generate XMLThe value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML.
generate-json\n \n Generate JSONThe value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON.
generate-turtle\n \n Generate TurtleThe value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle.
html-template\n \n HTML TemplateThe value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).
\n
" - }, - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode": "fhir" - } - ], - "url": "http://hl7.org/fhir/guide-parameter-code", - "identifier": [ - { - "system": "urn:ietf:rfc:3986", - "value": "urn:oid:2.16.840.1.113883.4.642.4.997" - } - ], - "version": "5.0.0-ballot", - "name": "GuideParameterCode", - "status": "draft", - "experimental": false, - "caseSensitive": true, - "content": "complete", - "concept": [ - { - "code": "apply", - "display": "Apply Metadata Value", - "definition": "If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext." - }, - { - "code": "path-resource", - "display": "Resource Path", - "definition": "The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type." - }, - { - "code": "path-pages", - "display": "Pages Path", - "definition": "The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder." - }, - { - "code": "path-tx-cache", - "display": "Terminology Cache Path", - "definition": "The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control." - }, - { - "code": "expansion-parameter", - "display": "Expansion Profile", - "definition": "The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT." - }, - { - "code": "rule-broken-links", - "display": "Broken Links Rule", - "definition": "The value of this string 0..1 parameter is either \"warning\" or \"error\" (default = \"error\"). If the value is \"warning\" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links." - }, - { - "code": "generate-xml", - "display": "Generate XML", - "definition": "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML." - }, - { - "code": "generate-json", - "display": "Generate JSON", - "definition": "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON." - }, - { - "code": "generate-turtle", - "display": "Generate Turtle", - "definition": "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle." - }, - { - "code": "html-template", - "display": "HTML Template", - "definition": "The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating)." - } - ] -} \ No newline at end of file +{"resourceType":"CodeSystem","id":"guide-parameter-code","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00","profile":["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]},"text":{"status":"generated","div":"
\n

This code system \n http://hl7.org/fhir/guide-parameter-code defines the following codes:\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Code\n \n Display\n \n Definition\n
apply\n \n Apply Metadata ValueIf the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.
path-resource\n \n Resource PathThe value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type.
path-pages\n \n Pages PathThe value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.
path-tx-cache\n \n Terminology Cache PathThe value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control.
expansion-parameter\n \n Expansion ProfileThe value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT.
rule-broken-links\n \n Broken Links RuleThe value of this string 0..1 parameter is either "warning" or "error" (default = "error"). If the value is "warning" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.
generate-xml\n \n Generate XMLThe value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML.
generate-json\n \n Generate JSONThe value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON.
generate-turtle\n \n Generate TurtleThe value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle.
html-template\n \n HTML TemplateThe value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"url":"http://hl7.org/fhir/guide-parameter-code","identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:2.16.840.1.113883.4.642.4.997"}],"version":"5.0.0","name":"GuideParameterCode","title":"Guide Parameter Code","status":"active","experimental":true,"publisher":"HL7 International","description":"GuideParameterCode","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"caseSensitive":true,"content":"complete","concept":[{"code":"apply","display":"Apply Metadata Value","definition":"If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext."},{"code":"path-resource","display":"Resource Path","definition":"The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type."},{"code":"path-pages","display":"Pages Path","definition":"The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder."},{"code":"path-tx-cache","display":"Terminology Cache Path","definition":"The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control."},{"code":"expansion-parameter","display":"Expansion Profile","definition":"The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT."},{"code":"rule-broken-links","display":"Broken Links Rule","definition":"The value of this string 0..1 parameter is either \"warning\" or \"error\" (default = \"error\"). If the value is \"warning\" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links."},{"code":"generate-xml","display":"Generate XML","definition":"The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML."},{"code":"generate-json","display":"Generate JSON","definition":"The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON."},{"code":"generate-turtle","display":"Generate Turtle","definition":"The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle."},{"code":"html-template","display":"HTML Template","definition":"The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating)."}]} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CarePlan.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CarePlan.json index b27f9c0bf..52b61d509 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CarePlan.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CarePlan.json @@ -1,3767 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "CarePlan", - "meta" : { - "lastUpdated" : "2021-03-08T08:13:23.790+00:00" - }, - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" CarePlan TUDomainResourceHealthcare plan for patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier Σ0..*IdentifierExternal Ids for this plan
\".\"\".\"\".\" instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
\".\"\".\"\".\" instantiatesUri Σ0..*uriInstantiates external protocol or definition
\".\"\".\"\".\" basedOn Σ0..*Reference(CarePlan)Fulfills CarePlan
\".\"\".\"\".\" replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
\".\"\".\"\".\" partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
\".\"\".\"\".\" status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required)
\".\"\".\"\".\" intent ?!Σ1..1codeproposal | plan | order | option | directive
Care Plan Intent (Required)
\".\"\".\"\".\" category Σ0..*CodeableConceptType of plan
Care Plan Category (Example)
\".\"\".\"\".\" title Σ0..1stringHuman-friendly name for the care plan
\".\"\".\"\".\" description Σ0..1stringSummary of nature of plan
\".\"\".\"\".\" subject Σ1..1Reference(Patient | Group)Who the care plan is for
\".\"\".\"\".\" encounter Σ0..1Reference(Encounter)The Encounter during which this CarePlan was created
\".\"\".\"\".\" period Σ0..1PeriodTime period plan covers
\".\"\".\"\".\" created Σ0..1dateTimeDate record was first recorded
\".\"\".\"\".\" author Σ0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who is the designated responsible party
\".\"\".\"\".\" contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
\".\"\".\"\".\" careTeam 0..*Reference(CareTeam)Who's involved in plan?
\".\"\".\"\".\" addresses Σ0..*CodeableReference(Condition)Health issues this plan addresses
SNOMED CT Clinical Findings (Example)
\".\"\".\"\".\" supportingInfo 0..*Reference(Any)Information considered as part of plan
\".\"\".\"\".\" goal 0..*Reference(Goal)Desired outcome of plan
\".\"\".\"\".\" activity I0..*BackboneElementAction to occur or has occurred as part of plan
+ Rule: Provide a plannedActivityReference or plannedActivityDetail, not both
\".\"\".\"\".\"\".\" performedActivity 0..*CodeableReference(Any)Results of the activity (concept, or Appointment, Encounter, Procedure, etc)
Care Plan Activity Performed (Example)
\".\"\".\"\".\"\".\" progress 0..*AnnotationComments about the activity status/progress
\".\"\".\"\".\"\".\" plannedActivityReference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup | ImmunizationRecommendation)Activity that is intended to be part of the care plan
\".\"\".\"\".\"\".\" plannedActivityDetail I0..1BackboneElementIn-line definition of activity
\".\"\".\"\".\"\".\"\".\" kind 0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Care Plan Activity Kind (Required)
\".\"\".\"\".\"\".\"\".\" instantiatesCanonical 0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
\".\"\".\"\".\"\".\"\".\" instantiatesUri 0..*uriInstantiates external protocol or definition
\".\"\".\"\".\"\".\"\".\" code 0..1CodeableConceptDetail type of activity
Procedure Codes (SNOMED CT) (Example)
\".\"\".\"\".\"\".\"\".\" reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity should be done or why activity was prohibited
SNOMED CT Clinical Findings (Example)
\".\"\".\"\".\"\".\"\".\" goal 0..*Reference(Goal)Goals this activity relates to
\".\"\".\"\".\"\".\"\".\" status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
CarePlanActivityStatus (Required)
\".\"\".\"\".\"\".\"\".\" statusReason 0..1CodeableConceptReason for current status
Care Plan Activity Status Reason (Example)
\".\"\".\"\".\"\".\"\".\" doNotPerform ?!0..1booleanIf true, activity is prohibiting action
\".\"\".\"\".\"\".\"\".\" scheduled[x] 0..1When activity is to occur
\".\"\".\"\".\"\".\"\".\"\".\" scheduledTimingTiming
\".\"\".\"\".\"\".\"\".\"\".\" scheduledPeriodPeriod
\".\"\".\"\".\"\".\"\".\"\".\" scheduledStringstring
\".\"\".\"\".\"\".\"\".\" location 0..1CodeableReference(Location)Where it should happen
ServiceDeliveryLocationRoleType (Extensible)
\".\"\".\"\".\"\".\"\".\" reported[x] 0..1Reported rather than primary record
\".\"\".\"\".\"\".\"\".\"\".\" reportedBooleanboolean
\".\"\".\"\".\"\".\"\".\"\".\" reportedReferenceReference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
\".\"\".\"\".\"\".\"\".\" performer 0..*Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
\".\"\".\"\".\"\".\"\".\" product[x] 0..1What is to be administered/supplied
SNOMED CT Medication Codes (Example)
\".\"\".\"\".\"\".\"\".\"\".\" productCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\"\".\"\".\" productReferenceReference(Medication | Substance)
\".\"\".\"\".\"\".\"\".\" dailyAmount 0..1SimpleQuantityHow to consume/day?
\".\"\".\"\".\"\".\"\".\" quantity 0..1SimpleQuantityHow much to administer/supply/consume
\".\"\".\"\".\"\".\"\".\" description 0..1stringExtra info describing activity to perform
\".\"\".\"\".\" note 0..*AnnotationComments about the plan

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 2 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", - "valueCode" : "patient" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "pc" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/CarePlan", - "version" : "4.5.0", - "name" : "CarePlan", - "status" : "draft", - "date" : "2021-03-08T08:13:23+00:00", - "publisher" : "Health Level Seven International (Patient Care)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }, - { - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm" - }] - }], - "fhirVersion" : "4.5.0", - "mapping" : [{ - "identity" : "workflow", - "uri" : "http://hl7.org/fhir/workflow", - "name" : "Workflow Pattern" - }, - { - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }, - { - "identity" : "v2", - "uri" : "http://hl7.org/v2", - "name" : "HL7 v2 Mapping" - }], - "kind" : "resource", - "abstract" : false, - "type" : "CarePlan", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "CarePlan", - "path" : "CarePlan", - "short" : "Healthcare plan for patient or group", - "definition" : "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.", - "alias" : ["Care Team"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan", - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "workflow", - "map" : "Request" - }, - { - "identity" : "rim", - "map" : "Act[classCode=PCPR, moodCode=INT]" - }, - { - "identity" : "w5", - "map" : "clinical.careprovision" - }] - }, - { - "id" : "CarePlan.id", - "path" : "CarePlan.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "CarePlan.meta", - "path" : "CarePlan.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "CarePlan.implicitRules", - "path" : "CarePlan.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "CarePlan.language", - "path" : "CarePlan.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "CarePlan.text", - "path" : "CarePlan.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "CarePlan.contained", - "path" : "CarePlan.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "CarePlan.extension", - "path" : "CarePlan.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "CarePlan.modifierExtension", - "path" : "CarePlan.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "CarePlan.identifier", - "path" : "CarePlan.identifier", - "short" : "External Ids for this plan", - "definition" : "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.", - "comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.", - "requirements" : "Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "v2", - "map" : "PTH-3" - }, - { - "identity" : "rim", - "map" : ".id" - }] - }, - { - "id" : "CarePlan.instantiatesCanonical", - "path" : "CarePlan.instantiatesCanonical", - "short" : "Instantiates FHIR protocol or definition", - "definition" : "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.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.instantiatesCanonical", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition", - "http://hl7.org/fhir/StructureDefinition/Questionnaire", - "http://hl7.org/fhir/StructureDefinition/Measure", - "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", - "http://hl7.org/fhir/StructureDefinition/OperationDefinition"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesCanonical" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.instantiatesUri", - "path" : "CarePlan.instantiatesUri", - "short" : "Instantiates external protocol or definition", - "definition" : "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.", - "comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.instantiatesUri", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesUri" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.basedOn", - "path" : "CarePlan.basedOn", - "short" : "Fulfills CarePlan", - "definition" : "A care plan that is fulfilled in whole or in part by this care plan.", - "requirements" : "Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.", - "alias" : ["fulfills"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.basedOn", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.basedOn" - }] - }, - { - "id" : "CarePlan.replaces", - "path" : "CarePlan.replaces", - "short" : "CarePlan replaced by this CarePlan", - "definition" : "Completed or terminated care plan whose function is taken by this new care plan.", - "comment" : "The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.", - "requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.", - "alias" : ["supersedes"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.replaces", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.replaces" - }] - }, - { - "id" : "CarePlan.partOf", - "path" : "CarePlan.partOf", - "short" : "Part of referenced CarePlan", - "definition" : "A larger care plan of which this particular care plan is a component or step.", - "comment" : "Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.partOf", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "CarePlan.status", - "path" : "CarePlan.status", - "short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown", - "definition" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.", - "comment" : "The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.", - "requirements" : "Allows clinicians to determine whether the plan is actionable or not.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "CarePlan.status", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanStatus" - }], - "strength" : "required", - "description" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.", - "valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.5.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.status {uses different ValueSet}" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "v2", - "map" : "PTH-5" - }, - { - "identity" : "rim", - "map" : ".statusCode planned = new active = active completed = completed" - }] - }, - { - "id" : "CarePlan.intent", - "path" : "CarePlan.intent", - "short" : "proposal | plan | order | option | directive", - "definition" : "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.", - "comment" : "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.\nThis element is expected to be immutable. E.g. A \"proposal\" instance should never change to be a \"plan\" instance or \"order\" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.", - "requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "CarePlan.intent", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request\"", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanIntent" - }], - "strength" : "required", - "description" : "Codes indicating the degree of authority/intentionality associated with a care plan.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-intent|4.5.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.intent" - }] - }, - { - "id" : "CarePlan.category", - "path" : "CarePlan.category", - "short" : "Type of plan", - "definition" : "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.", - "comment" : "There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.", - "requirements" : "Used for filtering what plan(s) are retrieved and displayed to different types of users.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanCategory" - }], - "strength" : "example", - "description" : "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }] - }, - { - "id" : "CarePlan.title", - "path" : "CarePlan.title", - "short" : "Human-friendly name for the care plan", - "definition" : "Human-friendly name for the care plan.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.title", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "CarePlan.description", - "path" : "CarePlan.description", - "short" : "Summary of nature of plan", - "definition" : "A description of the scope and nature of the plan.", - "requirements" : "Provides more detail than conveyed by category.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.description", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }] - }, - { - "id" : "CarePlan.subject", - "path" : "CarePlan.subject", - "short" : "Who the care plan is for", - "definition" : "Identifies the patient or group whose intended care is described by the plan.", - "alias" : ["patient"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "CarePlan.subject", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.subject" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PAT].role[classCode=PAT]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "CarePlan.encounter", - "path" : "CarePlan.encounter", - "short" : "The Encounter during which this CarePlan was created", - "definition" : "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.", - "comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.encounter", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.context" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "Associated PV1" - }, - { - "identity" : "rim", - "map" : "." - }] - }, - { - "id" : "CarePlan.period", - "path" : "CarePlan.period", - "short" : "Time period plan covers", - "definition" : "Indicates when the plan did (or is intended to) come into effect and end.", - "comment" : "Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).", - "requirements" : "Allows tracking what plan(s) are in effect at a particular time.", - "alias" : ["timing"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.period", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Period" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.occurrence[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.planned" - }, - { - "identity" : "v2", - "map" : "GOL-7 / GOL-8" - }, - { - "identity" : "rim", - "map" : ".effectiveTime" - }] - }, - { - "id" : "CarePlan.created", - "path" : "CarePlan.created", - "short" : "Date record was first recorded", - "definition" : "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.", - "alias" : ["authoredOn"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.created", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.authoredOn" - }, - { - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].time" - }] - }, - { - "id" : "CarePlan.author", - "path" : "CarePlan.author", - "short" : "Who is the designated responsible party", - "definition" : "When populated, the author is responsible for the care plan. The care plan is attributed to the author.", - "comment" : "The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.author", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/CareTeam"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.requester" - }, - { - "identity" : "w5", - "map" : "FiveWs.author" - }] - }, - { - "id" : "CarePlan.contributor", - "path" : "CarePlan.contributor", - "short" : "Who provided the content of the care plan", - "definition" : "Identifies the individual(s) or organization who provided the contents of the care plan.", - "comment" : "Collaborative care plans may have multiple contributors.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.contributor", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/CareTeam"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "CarePlan.careTeam", - "path" : "CarePlan.careTeam", - "short" : "Who's involved in plan?", - "definition" : "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.", - "requirements" : "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.careTeam", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performer {similar but does not entail CareTeam}" - }, - { - "identity" : "w5", - "map" : "FiveWs.actor" - }] - }, - { - "id" : "CarePlan.addresses", - "path" : "CarePlan.addresses", - "short" : "Health issues this plan addresses", - "definition" : "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.", - "comment" : "Use CarePlan.addresses.concept when a code sufficiently describes the concern (e.g. condition, problem, diagnosis, risk). Use CarePlan.addresses.reference when referencing a resource, which allows more information to be conveyed, such as onset date. CarePlan.addresses.concept and CarePlan.addresses.reference are not meant to be duplicative. For a single concern, either CarePlan.addresses.concept or CarePlan.addresses.reference can be used. CarePlan.addresses.concept may be a summary code, or CarePlan.addresses.reference may be used to reference a very precise definition of the concern using Condition. Both CarePlan.addresses.concept and CarePlan.addresses.reference can be used if they are describing different concerns for the care plan.", - "requirements" : "The element can identify risks addressed by the plan as well as concerns. Also scopes plans - multiple plans may exist addressing different concerns.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.addresses", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanAddresses" - }], - "strength" : "example", - "description" : "Codes that describe the health issues this plan addresses.", - "valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reasonCode" - }, - { - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "v2", - "map" : "PRB-4" - }, - { - "identity" : "rim", - "map" : ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]" - }] - }, - { - "id" : "CarePlan.supportingInfo", - "path" : "CarePlan.supportingInfo", - "short" : "Information considered as part of plan", - "definition" : "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.", - "comment" : "Use \"concern\" to identify specific conditions addressed by the care plan. supportingInfo can be used to convey one or more Advance Directives or Medical Treatment Consent Directives by referencing Consent or any other request resource with intent = directive.", - "requirements" : "Identifies barriers and other considerations associated with the care plan.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.supportingInfo", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.supportingInfo" - }] - }, - { - "id" : "CarePlan.goal", - "path" : "CarePlan.goal", - "short" : "Desired outcome of plan", - "definition" : "Describes the intended objective(s) of carrying out the care plan.", - "comment" : "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.", - "requirements" : "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.goal", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "GOL.1" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode<=OBJ]." - }] - }, - { - "id" : "CarePlan.activity", - "path" : "CarePlan.activity", - "short" : "Action to occur or has occurred as part of plan", - "definition" : "Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.", - "requirements" : "Allows systems to prompt for performance of planned activities, and validate plans against best practice.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "cpl-3", - "severity" : "error", - "human" : "Provide a plannedActivityReference or plannedActivityDetail, not both", - "expression" : "plannedActivityDetail.empty() or plannedActivityReference.empty()", - "xpath" : "not(exists(f:plannedActivityDetail)) or not(exists(f:plannedActivityReference))", - "source" : "http://hl7.org/fhir/StructureDefinition/CarePlan" - }, - { - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "{no mapping\nNOTE: This is a list of contained Request-Event tuples!}" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP].target" - }] - }, - { - "id" : "CarePlan.activity.id", - "path" : "CarePlan.activity.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "CarePlan.activity.extension", - "path" : "CarePlan.activity.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "CarePlan.activity.modifierExtension", - "path" : "CarePlan.activity.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "CarePlan.activity.performedActivity", - "path" : "CarePlan.activity.performedActivity", - "short" : "Results of the activity (concept, or Appointment, Encounter, Procedure, etc)", - "definition" : "Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using CarePlan.activity.plannedActivityDetail OR using the CarePlan.activity.plannedActivityReference (a reference to a “request” resource).", - "comment" : "Note that this should not duplicate the activity status (e.g. completed or in progress). The activity performed is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to exercise, then the activity performed could be amount and intensity of exercise performed whereas the goal outcome is an observation for the actual body weight measured.", - "requirements" : "Links plan to resulting actions.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity.performedActivity", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityPerformed" - }], - "strength" : "example", - "description" : "Identifies the results of the activity.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-performed" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "{Event that is outcome of Request in activity.plannedActivityReference}" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=FLFS].source" - }] - }, - { - "id" : "CarePlan.activity.progress", - "path" : "CarePlan.activity.progress", - "short" : "Comments about the activity status/progress", - "definition" : "Notes about the adherence/status/progress of the activity.", - "comment" : "This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.", - "requirements" : "Can be used to capture information about adherence, progress, concerns, etc.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity.progress", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "NTE?" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityReference", - "path" : "CarePlan.activity.plannedActivityReference", - "short" : "Activity that is intended to be part of the care plan", - "definition" : "The details of the proposed activity represented in a specific resource.", - "comment" : "Standard extension exists ([resource-pertainsToGoal](extension-resource-pertainstogoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.plannedActivityReference. \nThe goal should be visible when the resource referenced by CarePlan.activity.plannedActivityReference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan.", - "requirements" : "Details in a form consistent with other applications and contexts of use.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityReference", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Appointment", - "http://hl7.org/fhir/StructureDefinition/CommunicationRequest", - "http://hl7.org/fhir/StructureDefinition/DeviceRequest", - "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "http://hl7.org/fhir/StructureDefinition/NutritionOrder", - "http://hl7.org/fhir/StructureDefinition/Task", - "http://hl7.org/fhir/StructureDefinition/ServiceRequest", - "http://hl7.org/fhir/StructureDefinition/VisionPrescription", - "http://hl7.org/fhir/StructureDefinition/RequestGroup", - "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"] - }], - "condition" : ["cpl-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "{Request that resulted in Event in activity.performedActivity}" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail", - "path" : "CarePlan.activity.plannedActivityDetail", - "short" : "In-line definition of activity", - "definition" : "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.", - "requirements" : "Details in a simple form for generic care plan systems.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["cpl-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.id", - "path" : "CarePlan.activity.plannedActivityDetail.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.extension", - "path" : "CarePlan.activity.plannedActivityDetail.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.modifierExtension", - "path" : "CarePlan.activity.plannedActivityDetail.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.kind", - "path" : "CarePlan.activity.plannedActivityDetail.kind", - "short" : "Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription", - "definition" : "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.", - "requirements" : "May determine what types of extensions are permitted.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.kind", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityKind" - }], - "strength" : "required", - "description" : "Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.5.0" - }, - "mapping" : [{ - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.instantiatesCanonical", - "path" : "CarePlan.activity.plannedActivityDetail.instantiatesCanonical", - "short" : "Instantiates FHIR protocol or definition", - "definition" : "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.", - "requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.instantiatesCanonical", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition", - "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", - "http://hl7.org/fhir/StructureDefinition/Questionnaire", - "http://hl7.org/fhir/StructureDefinition/Measure", - "http://hl7.org/fhir/StructureDefinition/OperationDefinition"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesCanonical" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.instantiatesUri", - "path" : "CarePlan.activity.plannedActivityDetail.instantiatesUri", - "short" : "Instantiates external protocol or definition", - "definition" : "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.", - "comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", - "requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.instantiatesUri", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesUri" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.code", - "path" : "CarePlan.activity.plannedActivityDetail.code", - "short" : "Detail type of activity", - "definition" : "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.", - "comment" : "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.", - "requirements" : "Allows matching performed to planned as well as validation against protocols.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityType" - }], - "strength" : "example", - "description" : "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.", - "valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.code" - }, - { - "identity" : "v2", - "map" : "OBR-4 / RXE-2 / RXO-1 / RXD-2" - }, - { - "identity" : "rim", - "map" : ".code" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.reason", - "path" : "CarePlan.activity.plannedActivityDetail.reason", - "short" : "Why activity should be done or why activity was prohibited", - "definition" : "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited - either a coded concept, or 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.", - "comment" : "This could be a diagnosis code. If a full condition record exists, us reason.reference instead. Conditions can be identified at the activity level that are not identified as reasons for the overall plan.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.reason", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition", - "http://hl7.org/fhir/StructureDefinition/Observation", - "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", - "http://hl7.org/fhir/StructureDefinition/DocumentReference"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityReason" - }], - "strength" : "example", - "description" : "Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as \"general wellness\", prophylaxis, surgical preparation, etc.", - "valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reasonCode" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.goal", - "path" : "CarePlan.activity.plannedActivityDetail.goal", - "short" : "Goals this activity relates to", - "definition" : "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.", - "requirements" : "So that participants know the link explicitly.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.goal", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".outboundRelationship[typeCode<=OBJ]." - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.status", - "path" : "CarePlan.activity.plannedActivityDetail.status", - "short" : "not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error", - "definition" : "Identifies what progress is being made for the specific activity.", - "comment" : "Some aspects of status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated. \nThe unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.", - "requirements" : "Indicates progress against the plan, whether the activity is still relevant for the plan.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.status", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid", - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityStatus" - }], - "strength" : "required", - "description" : "Codes that reflect the current state of a care plan activity within its overall life cycle.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.5.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.status" - }, - { - "identity" : "v2", - "map" : "ORC-5?" - }, - { - "identity" : "rim", - "map" : ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.statusReason", - "path" : "CarePlan.activity.plannedActivityDetail.statusReason", - "short" : "Reason for current status", - "definition" : "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.", - "comment" : "Will generally not be present if status is \"complete\". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.statusReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityStatusReason" - }], - "strength" : "example", - "description" : "Codes that describe the reason why the activity isn't yet started, is on hold, was cancelled, etc.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status-reason" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.statusReason" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.doNotPerform", - "path" : "CarePlan.activity.plannedActivityDetail.doNotPerform", - "short" : "If true, activity is prohibiting action", - "definition" : "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.", - "comment" : "This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.", - "requirements" : "Captures intention to not do something that may have been previously typical.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.doNotPerform", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "If missing indicates that the described activity is one that should be engaged in when following the plan.", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur.", - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.doNotPerform" - }, - { - "identity" : "rim", - "map" : "actionNegationInd" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.scheduled[x]", - "path" : "CarePlan.activity.plannedActivityDetail.scheduled[x]", - "short" : "When activity is to occur", - "definition" : "The period, timing or frequency upon which the described activity is to occur.", - "requirements" : "Allows prompting for activities and detection of missed planned activities.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.scheduled[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Timing" - }, - { - "code" : "Period" - }, - { - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.occurrence[x]" - }, - { - "identity" : "v2", - "map" : "TQ1" - }, - { - "identity" : "rim", - "map" : ".effectiveTime" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.location", - "path" : "CarePlan.activity.plannedActivityDetail.location", - "short" : "Where it should happen", - "definition" : "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.", - "comment" : "May reference a specific clinical location or may identify a type of location.", - "requirements" : "Helps in planning of activity.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.location", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityLocation" - }], - "strength" : "extensible", - "description" : "A location type where services are delivered.", - "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "OBR-24(???!!)" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=LOC].role" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.reported[x]", - "path" : "CarePlan.activity.plannedActivityDetail.reported[x]", - "short" : "Reported rather than primary record", - "definition" : "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.", - "requirements" : "Reported data may have different rules on editing and may be visually distinguished from primary data.", - "alias" : ["informer"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.reported[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }, - { - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reported[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.source" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=RPT].role" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.performer", - "path" : "CarePlan.activity.plannedActivityDetail.performer", - "short" : "Who will be responsible?", - "definition" : "Identifies who's expected to be involved in the activity.", - "comment" : "A performer MAY also be a participant in the care plan.", - "requirements" : "Helps in planning of activity.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.performer", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/CareTeam", - "http://hl7.org/fhir/StructureDefinition/HealthcareService", - "http://hl7.org/fhir/StructureDefinition/Device"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performer" - }, - { - "identity" : "v2", - "map" : "PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PFM]" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.product[x]", - "path" : "CarePlan.activity.plannedActivityDetail.product[x]", - "short" : "What is to be administered/supplied", - "definition" : "Identifies the food, drug or other product to be consumed or supplied in the activity.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.product[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }, - { - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication", - "http://hl7.org/fhir/StructureDefinition/Substance"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanProduct" - }], - "strength" : "example", - "description" : "A product supplied or administered as part of a care plan activity.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "RXE-2 / RXO-1 / RXD-2" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PRD].role" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.dailyAmount", - "path" : "CarePlan.activity.plannedActivityDetail.dailyAmount", - "short" : "How to consume/day?", - "definition" : "Identifies the quantity expected to be consumed in a given day.", - "requirements" : "Allows rough dose checking.", - "alias" : ["daily dose"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.dailyAmount", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "RXO-23 / RXE-19 / RXD-12" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.quantity", - "path" : "CarePlan.activity.plannedActivityDetail.quantity", - "short" : "How much to administer/supply/consume", - "definition" : "Identifies the quantity expected to be supplied, administered or consumed by the subject.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.quantity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.description", - "path" : "CarePlan.activity.plannedActivityDetail.description", - "short" : "Extra info describing activity to perform", - "definition" : "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.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CarePlan.activity.plannedActivityDetail.description", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "NTE?" - }, - { - "identity" : "rim", - "map" : ".text" - }] - }, - { - "id" : "CarePlan.note", - "path" : "CarePlan.note", - "short" : "Comments about the plan", - "definition" : "General notes about the care plan not covered elsewhere.", - "requirements" : "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CarePlan.note", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.note" - }, - { - "identity" : "v2", - "map" : "NTE?" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "CarePlan", - "path" : "CarePlan", - "short" : "Healthcare plan for patient or group", - "definition" : "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.", - "alias" : ["Care Team"], - "min" : 0, - "max" : "*", - "mustSupport" : false, - "isModifier" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request" - }, - { - "identity" : "rim", - "map" : "Act[classCode=PCPR, moodCode=INT]" - }, - { - "identity" : "w5", - "map" : "clinical.careprovision" - }] - }, - { - "id" : "CarePlan.identifier", - "path" : "CarePlan.identifier", - "short" : "External Ids for this plan", - "definition" : "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.", - "comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.", - "requirements" : "Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Identifier" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "v2", - "map" : "PTH-3" - }, - { - "identity" : "rim", - "map" : ".id" - }] - }, - { - "id" : "CarePlan.instantiatesCanonical", - "path" : "CarePlan.instantiatesCanonical", - "short" : "Instantiates FHIR protocol or definition", - "definition" : "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.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition", - "http://hl7.org/fhir/StructureDefinition/Questionnaire", - "http://hl7.org/fhir/StructureDefinition/Measure", - "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", - "http://hl7.org/fhir/StructureDefinition/OperationDefinition"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesCanonical" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.instantiatesUri", - "path" : "CarePlan.instantiatesUri", - "short" : "Instantiates external protocol or definition", - "definition" : "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.", - "comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "uri" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesUri" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.basedOn", - "path" : "CarePlan.basedOn", - "short" : "Fulfills CarePlan", - "definition" : "A care plan that is fulfilled in whole or in part by this care plan.", - "requirements" : "Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.", - "alias" : ["fulfills"], - "min" : 0, - "max" : "*", - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.basedOn" - }] - }, - { - "id" : "CarePlan.replaces", - "path" : "CarePlan.replaces", - "short" : "CarePlan replaced by this CarePlan", - "definition" : "Completed or terminated care plan whose function is taken by this new care plan.", - "comment" : "The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.", - "requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.", - "alias" : ["supersedes"], - "min" : 0, - "max" : "*", - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.replaces" - }] - }, - { - "id" : "CarePlan.partOf", - "path" : "CarePlan.partOf", - "short" : "Part of referenced CarePlan", - "definition" : "A larger care plan of which this particular care plan is a component or step.", - "comment" : "Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.", - "min" : 0, - "max" : "*", - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "CarePlan.status", - "path" : "CarePlan.status", - "short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown", - "definition" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.", - "comment" : "The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.", - "requirements" : "Allows clinicians to determine whether the plan is actionable or not.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanStatus" - }], - "strength" : "required", - "description" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.", - "valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.5.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.status {uses different ValueSet}" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "v2", - "map" : "PTH-5" - }, - { - "identity" : "rim", - "map" : ".statusCode planned = new active = active completed = completed" - }] - }, - { - "id" : "CarePlan.intent", - "path" : "CarePlan.intent", - "short" : "proposal | plan | order | option | directive", - "definition" : "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.", - "comment" : "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.\nThis element is expected to be immutable. E.g. A \"proposal\" instance should never change to be a \"plan\" instance or \"order\" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.", - "requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request\"", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanIntent" - }], - "strength" : "required", - "description" : "Codes indicating the degree of authority/intentionality associated with a care plan.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-intent|4.5.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.intent" - }] - }, - { - "id" : "CarePlan.category", - "path" : "CarePlan.category", - "short" : "Type of plan", - "definition" : "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.", - "comment" : "There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.", - "requirements" : "Used for filtering what plan(s) are retrieved and displayed to different types of users.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanCategory" - }], - "strength" : "example", - "description" : "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }] - }, - { - "id" : "CarePlan.title", - "path" : "CarePlan.title", - "short" : "Human-friendly name for the care plan", - "definition" : "Human-friendly name for the care plan.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "CarePlan.description", - "path" : "CarePlan.description", - "short" : "Summary of nature of plan", - "definition" : "A description of the scope and nature of the plan.", - "requirements" : "Provides more detail than conveyed by category.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }] - }, - { - "id" : "CarePlan.subject", - "path" : "CarePlan.subject", - "short" : "Who the care plan is for", - "definition" : "Identifies the patient or group whose intended care is described by the plan.", - "alias" : ["patient"], - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.subject" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PAT].role[classCode=PAT]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "CarePlan.encounter", - "path" : "CarePlan.encounter", - "short" : "The Encounter during which this CarePlan was created", - "definition" : "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.", - "comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.context" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "Associated PV1" - }, - { - "identity" : "rim", - "map" : "." - }] - }, - { - "id" : "CarePlan.period", - "path" : "CarePlan.period", - "short" : "Time period plan covers", - "definition" : "Indicates when the plan did (or is intended to) come into effect and end.", - "comment" : "Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).", - "requirements" : "Allows tracking what plan(s) are in effect at a particular time.", - "alias" : ["timing"], - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Period" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.occurrence[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.planned" - }, - { - "identity" : "v2", - "map" : "GOL-7 / GOL-8" - }, - { - "identity" : "rim", - "map" : ".effectiveTime" - }] - }, - { - "id" : "CarePlan.created", - "path" : "CarePlan.created", - "short" : "Date record was first recorded", - "definition" : "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.", - "alias" : ["authoredOn"], - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "dateTime" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.authoredOn" - }, - { - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].time" - }] - }, - { - "id" : "CarePlan.author", - "path" : "CarePlan.author", - "short" : "Who is the designated responsible party", - "definition" : "When populated, the author is responsible for the care plan. The care plan is attributed to the author.", - "comment" : "The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/CareTeam"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.requester" - }, - { - "identity" : "w5", - "map" : "FiveWs.author" - }] - }, - { - "id" : "CarePlan.contributor", - "path" : "CarePlan.contributor", - "short" : "Who provided the content of the care plan", - "definition" : "Identifies the individual(s) or organization who provided the contents of the care plan.", - "comment" : "Collaborative care plans may have multiple contributors.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/CareTeam"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "CarePlan.careTeam", - "path" : "CarePlan.careTeam", - "short" : "Who's involved in plan?", - "definition" : "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.", - "requirements" : "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performer {similar but does not entail CareTeam}" - }, - { - "identity" : "w5", - "map" : "FiveWs.actor" - }] - }, - { - "id" : "CarePlan.addresses", - "path" : "CarePlan.addresses", - "short" : "Health issues this plan addresses", - "definition" : "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.", - "comment" : "Use CarePlan.addresses.concept when a code sufficiently describes the concern (e.g. condition, problem, diagnosis, risk). Use CarePlan.addresses.reference when referencing a resource, which allows more information to be conveyed, such as onset date. CarePlan.addresses.concept and CarePlan.addresses.reference are not meant to be duplicative. For a single concern, either CarePlan.addresses.concept or CarePlan.addresses.reference can be used. CarePlan.addresses.concept may be a summary code, or CarePlan.addresses.reference may be used to reference a very precise definition of the concern using Condition. Both CarePlan.addresses.concept and CarePlan.addresses.reference can be used if they are describing different concerns for the care plan.", - "requirements" : "The element can identify risks addressed by the plan as well as concerns. Also scopes plans - multiple plans may exist addressing different concerns.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanAddresses" - }], - "strength" : "example", - "description" : "Codes that describe the health issues this plan addresses.", - "valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reasonCode" - }, - { - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "v2", - "map" : "PRB-4" - }, - { - "identity" : "rim", - "map" : ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]" - }] - }, - { - "id" : "CarePlan.supportingInfo", - "path" : "CarePlan.supportingInfo", - "short" : "Information considered as part of plan", - "definition" : "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.", - "comment" : "Use \"concern\" to identify specific conditions addressed by the care plan. supportingInfo can be used to convey one or more Advance Directives or Medical Treatment Consent Directives by referencing Consent or any other request resource with intent = directive.", - "requirements" : "Identifies barriers and other considerations associated with the care plan.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.supportingInfo" - }] - }, - { - "id" : "CarePlan.goal", - "path" : "CarePlan.goal", - "short" : "Desired outcome of plan", - "definition" : "Describes the intended objective(s) of carrying out the care plan.", - "comment" : "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.", - "requirements" : "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "GOL.1" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode<=OBJ]." - }] - }, - { - "id" : "CarePlan.activity", - "path" : "CarePlan.activity", - "short" : "Action to occur or has occurred as part of plan", - "definition" : "Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.", - "requirements" : "Allows systems to prompt for performance of planned activities, and validate plans against best practice.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "cpl-3", - "severity" : "error", - "human" : "Provide a plannedActivityReference or plannedActivityDetail, not both", - "expression" : "plannedActivityDetail.empty() or plannedActivityReference.empty()", - "xpath" : "not(exists(f:plannedActivityDetail)) or not(exists(f:plannedActivityReference))", - "source" : "http://hl7.org/fhir/StructureDefinition/CarePlan" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "{no mapping\nNOTE: This is a list of contained Request-Event tuples!}" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP].target" - }] - }, - { - "id" : "CarePlan.activity.performedActivity", - "path" : "CarePlan.activity.performedActivity", - "short" : "Results of the activity (concept, or Appointment, Encounter, Procedure, etc)", - "definition" : "Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using CarePlan.activity.plannedActivityDetail OR using the CarePlan.activity.plannedActivityReference (a reference to a “request” resource).", - "comment" : "Note that this should not duplicate the activity status (e.g. completed or in progress). The activity performed is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to exercise, then the activity performed could be amount and intensity of exercise performed whereas the goal outcome is an observation for the actual body weight measured.", - "requirements" : "Links plan to resulting actions.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityPerformed" - }], - "strength" : "example", - "description" : "Identifies the results of the activity.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-performed" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "{Event that is outcome of Request in activity.plannedActivityReference}" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=FLFS].source" - }] - }, - { - "id" : "CarePlan.activity.progress", - "path" : "CarePlan.activity.progress", - "short" : "Comments about the activity status/progress", - "definition" : "Notes about the adherence/status/progress of the activity.", - "comment" : "This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.", - "requirements" : "Can be used to capture information about adherence, progress, concerns, etc.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Annotation" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "NTE?" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityReference", - "path" : "CarePlan.activity.plannedActivityReference", - "short" : "Activity that is intended to be part of the care plan", - "definition" : "The details of the proposed activity represented in a specific resource.", - "comment" : "Standard extension exists ([resource-pertainsToGoal](extension-resource-pertainstogoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.plannedActivityReference. \nThe goal should be visible when the resource referenced by CarePlan.activity.plannedActivityReference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan.", - "requirements" : "Details in a form consistent with other applications and contexts of use.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Appointment", - "http://hl7.org/fhir/StructureDefinition/CommunicationRequest", - "http://hl7.org/fhir/StructureDefinition/DeviceRequest", - "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "http://hl7.org/fhir/StructureDefinition/NutritionOrder", - "http://hl7.org/fhir/StructureDefinition/Task", - "http://hl7.org/fhir/StructureDefinition/ServiceRequest", - "http://hl7.org/fhir/StructureDefinition/VisionPrescription", - "http://hl7.org/fhir/StructureDefinition/RequestGroup", - "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"] - }], - "condition" : ["cpl-3"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "{Request that resulted in Event in activity.performedActivity}" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail", - "path" : "CarePlan.activity.plannedActivityDetail", - "short" : "In-line definition of activity", - "definition" : "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.", - "requirements" : "Details in a simple form for generic care plan systems.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["cpl-3"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.kind", - "path" : "CarePlan.activity.plannedActivityDetail.kind", - "short" : "Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription", - "definition" : "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.", - "requirements" : "May determine what types of extensions are permitted.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityKind" - }], - "strength" : "required", - "description" : "Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.5.0" - }, - "mapping" : [{ - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.instantiatesCanonical", - "path" : "CarePlan.activity.plannedActivityDetail.instantiatesCanonical", - "short" : "Instantiates FHIR protocol or definition", - "definition" : "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.", - "requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition", - "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", - "http://hl7.org/fhir/StructureDefinition/Questionnaire", - "http://hl7.org/fhir/StructureDefinition/Measure", - "http://hl7.org/fhir/StructureDefinition/OperationDefinition"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesCanonical" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.instantiatesUri", - "path" : "CarePlan.activity.plannedActivityDetail.instantiatesUri", - "short" : "Instantiates external protocol or definition", - "definition" : "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.", - "comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", - "requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "uri" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiatesUri" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.code", - "path" : "CarePlan.activity.plannedActivityDetail.code", - "short" : "Detail type of activity", - "definition" : "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.", - "comment" : "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.", - "requirements" : "Allows matching performed to planned as well as validation against protocols.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityType" - }], - "strength" : "example", - "description" : "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.", - "valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.code" - }, - { - "identity" : "v2", - "map" : "OBR-4 / RXE-2 / RXO-1 / RXD-2" - }, - { - "identity" : "rim", - "map" : ".code" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.reason", - "path" : "CarePlan.activity.plannedActivityDetail.reason", - "short" : "Why activity should be done or why activity was prohibited", - "definition" : "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited - either a coded concept, or 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.", - "comment" : "This could be a diagnosis code. If a full condition record exists, us reason.reference instead. Conditions can be identified at the activity level that are not identified as reasons for the overall plan.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition", - "http://hl7.org/fhir/StructureDefinition/Observation", - "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", - "http://hl7.org/fhir/StructureDefinition/DocumentReference"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityReason" - }], - "strength" : "example", - "description" : "Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as \"general wellness\", prophylaxis, surgical preparation, etc.", - "valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reasonCode" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.goal", - "path" : "CarePlan.activity.plannedActivityDetail.goal", - "short" : "Goals this activity relates to", - "definition" : "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.", - "requirements" : "So that participants know the link explicitly.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".outboundRelationship[typeCode<=OBJ]." - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.status", - "path" : "CarePlan.activity.plannedActivityDetail.status", - "short" : "not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error", - "definition" : "Identifies what progress is being made for the specific activity.", - "comment" : "Some aspects of status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated. \nThe unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.", - "requirements" : "Indicates progress against the plan, whether the activity is still relevant for the plan.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid", - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityStatus" - }], - "strength" : "required", - "description" : "Codes that reflect the current state of a care plan activity within its overall life cycle.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.5.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.status" - }, - { - "identity" : "v2", - "map" : "ORC-5?" - }, - { - "identity" : "rim", - "map" : ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.statusReason", - "path" : "CarePlan.activity.plannedActivityDetail.statusReason", - "short" : "Reason for current status", - "definition" : "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.", - "comment" : "Will generally not be present if status is \"complete\". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityStatusReason" - }], - "strength" : "example", - "description" : "Codes that describe the reason why the activity isn't yet started, is on hold, was cancelled, etc.", - "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status-reason" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.statusReason" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.doNotPerform", - "path" : "CarePlan.activity.plannedActivityDetail.doNotPerform", - "short" : "If true, activity is prohibiting action", - "definition" : "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.", - "comment" : "This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.", - "requirements" : "Captures intention to not do something that may have been previously typical.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "If missing indicates that the described activity is one that should be engaged in when following the plan.", - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur.", - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.doNotPerform" - }, - { - "identity" : "rim", - "map" : "actionNegationInd" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.scheduled[x]", - "path" : "CarePlan.activity.plannedActivityDetail.scheduled[x]", - "short" : "When activity is to occur", - "definition" : "The period, timing or frequency upon which the described activity is to occur.", - "requirements" : "Allows prompting for activities and detection of missed planned activities.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Timing" - }, - { - "code" : "Period" - }, - { - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.occurrence[x]" - }, - { - "identity" : "v2", - "map" : "TQ1" - }, - { - "identity" : "rim", - "map" : ".effectiveTime" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.location", - "path" : "CarePlan.activity.plannedActivityDetail.location", - "short" : "Where it should happen", - "definition" : "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.", - "comment" : "May reference a specific clinical location or may identify a type of location.", - "requirements" : "Helps in planning of activity.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanActivityLocation" - }], - "strength" : "extensible", - "description" : "A location type where services are delivered.", - "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "OBR-24(???!!)" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=LOC].role" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.reported[x]", - "path" : "CarePlan.activity.plannedActivityDetail.reported[x]", - "short" : "Reported rather than primary record", - "definition" : "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.", - "requirements" : "Reported data may have different rules on editing and may be visually distinguished from primary data.", - "alias" : ["informer"], - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "boolean" - }, - { - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reported[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.source" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=RPT].role" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.performer", - "path" : "CarePlan.activity.plannedActivityDetail.performer", - "short" : "Who will be responsible?", - "definition" : "Identifies who's expected to be involved in the activity.", - "comment" : "A performer MAY also be a participant in the care plan.", - "requirements" : "Helps in planning of activity.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/CareTeam", - "http://hl7.org/fhir/StructureDefinition/HealthcareService", - "http://hl7.org/fhir/StructureDefinition/Device"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performer" - }, - { - "identity" : "v2", - "map" : "PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PFM]" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.product[x]", - "path" : "CarePlan.activity.plannedActivityDetail.product[x]", - "short" : "What is to be administered/supplied", - "definition" : "Identifies the food, drug or other product to be consumed or supplied in the activity.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }, - { - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication", - "http://hl7.org/fhir/StructureDefinition/Substance"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "CarePlanProduct" - }], - "strength" : "example", - "description" : "A product supplied or administered as part of a care plan activity.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "RXE-2 / RXO-1 / RXD-2" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PRD].role" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.dailyAmount", - "path" : "CarePlan.activity.plannedActivityDetail.dailyAmount", - "short" : "How to consume/day?", - "definition" : "Identifies the quantity expected to be consumed in a given day.", - "requirements" : "Allows rough dose checking.", - "alias" : ["daily dose"], - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "RXO-23 / RXE-19 / RXD-12" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.quantity", - "path" : "CarePlan.activity.plannedActivityDetail.quantity", - "short" : "How much to administer/supply/consume", - "definition" : "Identifies the quantity expected to be supplied, administered or consumed by the subject.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity" - }] - }, - { - "id" : "CarePlan.activity.plannedActivityDetail.description", - "path" : "CarePlan.activity.plannedActivityDetail.description", - "short" : "Extra info describing activity to perform", - "definition" : "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.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "NTE?" - }, - { - "identity" : "rim", - "map" : ".text" - }] - }, - { - "id" : "CarePlan.note", - "path" : "CarePlan.note", - "short" : "Comments about the plan", - "definition" : "General notes about the care plan not covered elsewhere.", - "requirements" : "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Annotation" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.note" - }, - { - "identity" : "v2", - "map" : "NTE?" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" - }] - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"CarePlan","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n CarePlan\n \n \n TU\n \n \n DomainResource\n Healthcare plan for patient or group\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n 0..*\n Identifier\n External Ids for this plan\n
\n
\n
\n \".\"\n \".\"\n \".\" \n instantiatesCanonical\n \n \n Σ\n 0..*\n canonical(\n PlanDefinition | \n Questionnaire | \n Measure | \n ActivityDefinition | \n OperationDefinition)\n Instantiates FHIR protocol or definition\n
\n
\n
\n \".\"\n \".\"\n \".\" \n instantiatesUri\n \n \n Σ\n 0..*\n uri\n Instantiates external protocol or definition\n
\n
\n
\n \".\"\n \".\"\n \".\" \n basedOn\n \n \n Σ\n 0..*\n Reference(\n CarePlan | \n ServiceRequest | \n RequestOrchestration | \n NutritionOrder)\n Fulfills plan, proposal or order\n
\n
\n
\n \".\"\n \".\"\n \".\" \n replaces\n \n \n Σ\n 0..*\n Reference(\n CarePlan)\n CarePlan replaced by this CarePlan\n
\n
\n
\n \".\"\n \".\"\n \".\" \n partOf\n \n \n Σ\n 0..*\n Reference(\n CarePlan)\n Part of referenced CarePlan\n
\n
\n
\n \".\"\n \".\"\n \".\" \n status\n \n \n ?!\n Σ\n 1..1\n code\n draft | active | on-hold | revoked | completed | entered-in-error | unknown\n
Binding: \n RequestStatus (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n intent\n \n \n ?!\n Σ\n 1..1\n code\n proposal | plan | order | option | directive\n
Binding: \n Care Plan Intent (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n category\n \n \n Σ\n 0..*\n CodeableConcept\n Type of plan\n
Binding: \n Care Plan Category (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n title\n \n \n Σ\n 0..1\n string\n Human-friendly name for the care plan\n
\n
\n \".\"\n \".\"\n \".\" \n description\n \n \n Σ\n 0..1\n string\n Summary of nature of plan\n
\n
\n \".\"\n \".\"\n \".\" \n subject\n \n \n Σ\n 1..1\n Reference(\n Patient | \n Group)\n Who the care plan is for\n
\n
\n \".\"\n \".\"\n \".\" \n encounter\n \n \n Σ\n 0..1\n Reference(\n Encounter)\n The Encounter during which this CarePlan was created\n
\n
\n \".\"\n \".\"\n \".\" \n period\n \n \n Σ\n 0..1\n Period\n Time period plan covers\n
\n
\n \".\"\n \".\"\n \".\" \n created\n \n \n Σ\n 0..1\n dateTime\n Date record was first recorded\n
\n
\n \".\"\n \".\"\n \".\" \n custodian\n \n \n Σ\n 0..1\n Reference(\n Patient | \n Practitioner | \n PractitionerRole | \n Device | \n RelatedPerson | \n Organization | \n CareTeam)\n Who is the designated responsible party\n
\n
\n \".\"\n \".\"\n \".\" \n contributor\n \n \n 0..*\n Reference(\n Patient | \n Practitioner | \n PractitionerRole | \n Device | \n RelatedPerson | \n Organization | \n CareTeam)\n Who provided the content of the care plan\n
\n
\n
\n \".\"\n \".\"\n \".\" \n careTeam\n \n \n 0..*\n Reference(\n CareTeam)\n Who's involved in plan?\n
\n
\n
\n \".\"\n \".\"\n \".\" \n addresses\n \n \n Σ\n 0..*\n CodeableReference(\n Condition)\n Health issues this plan addresses\n
Binding: \n SNOMED CT Clinical Findings (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n supportingInfo\n \n \n 0..*\n Reference(\n Any)\n Information considered as part of plan\n
\n
\n
\n \".\"\n \".\"\n \".\" \n goal\n \n \n 0..*\n Reference(\n Goal)\n Desired outcome of plan\n
\n
\n
\n \".\"\n \".\"\n \".\" \n activity\n \n \n 0..*\n BackboneElement\n Action to occur or has occurred as part of plan\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n performedActivity\n \n \n 0..*\n CodeableReference(\n Any)\n Results of the activity (concept, or Appointment, Encounter, Procedure, etc.)\n
Binding: \n Care Plan Activity Performed (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n progress\n \n \n 0..*\n Annotation\n Comments about the activity status/progress\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n plannedActivityReference\n \n \n 0..1\n Reference(\n Appointment | \n CommunicationRequest | \n DeviceRequest | \n MedicationRequest | \n NutritionOrder | \n Task | \n ServiceRequest | \n VisionPrescription | \n RequestOrchestration | \n ImmunizationRecommendation | \n SupplyRequest)\n Activity that is intended to be part of the care plan\n
\n
\n \".\"\n \".\"\n \".\" \n note\n \n \n 0..*\n Annotation\n Comments about the plan\n
\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Clinical.Care Provision"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":2},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pc"}],"url":"http://hl7.org/fhir/StructureDefinition/CarePlan","version":"5.0.0","name":"CarePlan","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (Patient Care)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/patientcare/index.cfm"}]}],"description":"Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"workflow","uri":"http://hl7.org/fhir/workflow","name":"Workflow Pattern"},{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"}],"kind":"resource","abstract":false,"type":"CarePlan","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"CarePlan","path":"CarePlan","short":"Healthcare plan for patient or group","definition":"Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.","alias":["Care Team"],"min":0,"max":"*","base":{"path":"CarePlan","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Act[classCode=PCPR, moodCode=INT]"},{"identity":"workflow","map":"Request"},{"identity":"w5","map":"clinical.careprovision"}]},{"id":"CarePlan.id","path":"CarePlan.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"CarePlan.meta","path":"CarePlan.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"CarePlan.implicitRules","path":"CarePlan.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"CarePlan.language","path":"CarePlan.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"CarePlan.text","path":"CarePlan.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"CarePlan.contained","path":"CarePlan.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"CarePlan.extension","path":"CarePlan.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"CarePlan.modifierExtension","path":"CarePlan.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"CarePlan.identifier","path":"CarePlan.identifier","short":"External Ids for this plan","definition":"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.","comment":"This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.","requirements":"Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.","min":0,"max":"*","base":{"path":"CarePlan.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PTH-3"},{"identity":"rim","map":".id"}]},{"id":"CarePlan.instantiatesCanonical","path":"CarePlan.instantiatesCanonical","short":"Instantiates FHIR protocol or definition","definition":"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.","min":0,"max":"*","base":{"path":"CarePlan.instantiatesCanonical","min":0,"max":"*"},"type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/PlanDefinition","http://hl7.org/fhir/StructureDefinition/Questionnaire","http://hl7.org/fhir/StructureDefinition/Measure","http://hl7.org/fhir/StructureDefinition/ActivityDefinition","http://hl7.org/fhir/StructureDefinition/OperationDefinition"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"CarePlan.instantiatesUri","path":"CarePlan.instantiatesUri","short":"Instantiates external protocol or definition","definition":"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.","comment":"This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.","min":0,"max":"*","base":{"path":"CarePlan.instantiatesUri","min":0,"max":"*"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.instantiatesUri"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"CarePlan.basedOn","path":"CarePlan.basedOn","short":"Fulfills plan, proposal or order","definition":"A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.","requirements":"Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.","alias":["fulfills"],"min":0,"max":"*","base":{"path":"CarePlan.basedOn","min":0,"max":"*"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/ServiceRequest","http://hl7.org/fhir/StructureDefinition/RequestOrchestration","http://hl7.org/fhir/StructureDefinition/NutritionOrder"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.basedOn"}]},{"id":"CarePlan.replaces","path":"CarePlan.replaces","short":"CarePlan replaced by this CarePlan","definition":"Completed or terminated care plan whose function is taken by this new care plan.","comment":"The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.","requirements":"Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.","alias":["supersedes"],"min":0,"max":"*","base":{"path":"CarePlan.replaces","min":0,"max":"*"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.replaces"}]},{"id":"CarePlan.partOf","path":"CarePlan.partOf","short":"Part of referenced CarePlan","definition":"A larger care plan of which this particular care plan is a component or step.","comment":"Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.","min":0,"max":"*","base":{"path":"CarePlan.partOf","min":0,"max":"*"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"CarePlan.status","path":"CarePlan.status","short":"draft | active | on-hold | revoked | completed | entered-in-error | unknown","definition":"Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.","comment":"The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.","requirements":"Allows clinicians to determine whether the plan is actionable or not.","min":1,"max":"1","base":{"path":"CarePlan.status","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanStatus"}],"strength":"required","description":"Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.","valueSet":"http://hl7.org/fhir/ValueSet/request-status|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.status {uses different ValueSet}"},{"identity":"w5","map":"FiveWs.status"},{"identity":"v2","map":"PTH-5"},{"identity":"rim","map":".statusCode planned = new active = active completed = completed"}]},{"id":"CarePlan.intent","path":"CarePlan.intent","short":"proposal | plan | order | option | directive","definition":"Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.","comment":"This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.\nThis element is expected to be immutable. E.g. A \"proposal\" instance should never change to be a \"plan\" instance or \"order\" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.","requirements":"Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.","min":1,"max":"1","base":{"path":"CarePlan.intent","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request\"","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanIntent"}],"strength":"required","description":"Codes indicating the degree of authority/intentionality associated with a care plan.","valueSet":"http://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.intent"}]},{"id":"CarePlan.category","path":"CarePlan.category","short":"Type of plan","definition":"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.","comment":"There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.addresses.","requirements":"Used for filtering what plan(s) are retrieved and displayed to different types of users.","min":0,"max":"*","base":{"path":"CarePlan.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanCategory"}],"strength":"example","description":"Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.","valueSet":"http://hl7.org/fhir/ValueSet/care-plan-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"}]},{"id":"CarePlan.title","path":"CarePlan.title","short":"Human-friendly name for the care plan","definition":"Human-friendly name for the care plan.","min":0,"max":"1","base":{"path":"CarePlan.title","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"CarePlan.description","path":"CarePlan.description","short":"Summary of nature of plan","definition":"A description of the scope and nature of the plan.","requirements":"Provides more detail than conveyed by category.","min":0,"max":"1","base":{"path":"CarePlan.description","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.what[x]"}]},{"id":"CarePlan.subject","path":"CarePlan.subject","short":"Who the care plan is for","definition":"Identifies the patient or group whose intended care is described by the plan.","alias":["patient"],"min":1,"max":"1","base":{"path":"CarePlan.subject","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":".participation[typeCode=PAT].role[classCode=PAT]"}]},{"id":"CarePlan.encounter","path":"CarePlan.encounter","short":"The Encounter during which this CarePlan was created","definition":"The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.","comment":"This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.","min":0,"max":"1","base":{"path":"CarePlan.encounter","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.encounter"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"Associated PV1"},{"identity":"rim","map":"."}]},{"id":"CarePlan.period","path":"CarePlan.period","short":"Time period plan covers","definition":"Indicates when the plan did (or is intended to) come into effect and end.","comment":"Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).","requirements":"Allows tracking what plan(s) are in effect at a particular time.","alias":["timing"],"min":0,"max":"1","base":{"path":"CarePlan.period","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.occurrence[x]"},{"identity":"w5","map":"FiveWs.planned"},{"identity":"v2","map":"GOL-7 / GOL-8"},{"identity":"rim","map":".effectiveTime"}]},{"id":"CarePlan.created","path":"CarePlan.created","short":"Date record was first recorded","definition":"Represents when this particular CarePlan record was created in the system, which is often a system-generated date.","alias":["authoredOn"],"min":0,"max":"1","base":{"path":"CarePlan.created","min":0,"max":"1"},"type":[{"code":"dateTime"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.authoredOn"},{"identity":"w5","map":"FiveWs.recorded"},{"identity":"rim","map":".participation[typeCode=AUT].time"}]},{"id":"CarePlan.custodian","path":"CarePlan.custodian","short":"Who is the designated responsible party","definition":"When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.","comment":"The custodian might or might not be a contributor.","min":0,"max":"1","base":{"path":"CarePlan.custodian","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.requester"},{"identity":"w5","map":"FiveWs.author"}]},{"id":"CarePlan.contributor","path":"CarePlan.contributor","short":"Who provided the content of the care plan","definition":"Identifies the individual(s), organization or device who provided the contents of the care plan.","comment":"Collaborative care plans may have multiple contributors.","min":0,"max":"*","base":{"path":"CarePlan.contributor","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"CarePlan.careTeam","path":"CarePlan.careTeam","short":"Who's involved in plan?","definition":"Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.","requirements":"Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.","min":0,"max":"*","base":{"path":"CarePlan.careTeam","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CareTeam"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.performer {similar but does not entail CareTeam}"},{"identity":"w5","map":"FiveWs.actor"}]},{"id":"CarePlan.addresses","path":"CarePlan.addresses","short":"Health issues this plan addresses","definition":"Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.","comment":"Use CarePlan.addresses.concept when a code sufficiently describes the concern (e.g. condition, problem, diagnosis, risk). Use CarePlan.addresses.reference when referencing a resource, which allows more information to be conveyed, such as onset date. CarePlan.addresses.concept and CarePlan.addresses.reference are not meant to be duplicative. For a single concern, either CarePlan.addresses.concept or CarePlan.addresses.reference can be used. CarePlan.addresses.concept may be a summary code, or CarePlan.addresses.reference may be used to reference a very precise definition of the concern using Condition. Both CarePlan.addresses.concept and CarePlan.addresses.reference can be used if they are describing different concerns for the care plan.","requirements":"The element can identify risks addressed by the plan as well as concerns. Also scopes plans - multiple plans may exist addressing different concerns.","min":0,"max":"*","base":{"path":"CarePlan.addresses","min":0,"max":"*"},"type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Condition"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanAddresses"}],"strength":"example","description":"Codes that describe the health issues this plan addresses.","valueSet":"http://hl7.org/fhir/ValueSet/clinical-findings"},"mapping":[{"identity":"workflow","map":"Request.reason"},{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"PRB-4"},{"identity":"rim","map":".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"}]},{"id":"CarePlan.supportingInfo","path":"CarePlan.supportingInfo","short":"Information considered as part of plan","definition":"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.","comment":"Use \"concern\" to identify specific conditions addressed by the care plan. supportingInfo can be used to convey one or more Advance Directives or Medical Treatment Consent Directives by referencing Consent or any other request resource with intent = directive.","requirements":"Identifies barriers and other considerations associated with the care plan.","min":0,"max":"*","base":{"path":"CarePlan.supportingInfo","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.supportingInfo"}]},{"id":"CarePlan.goal","path":"CarePlan.goal","short":"Desired outcome of plan","definition":"Describes the intended objective(s) of carrying out the care plan.","comment":"Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.","requirements":"Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.","min":0,"max":"*","base":{"path":"CarePlan.goal","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Goal"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"GOL-1"},{"identity":"rim","map":".outboundRelationship[typeCode<=OBJ]."}]},{"id":"CarePlan.activity","path":"CarePlan.activity","short":"Action to occur or has occurred as part of plan","definition":"Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.","requirements":"Allows systems to prompt for performance of planned activities, and validate plans against best practice.","min":0,"max":"*","base":{"path":"CarePlan.activity","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"{no mapping\nNOTE: This is a list of contained Request-Event tuples!}"},{"identity":"rim","map":".outboundRelationship[typeCode=COMP].target"}]},{"id":"CarePlan.activity.id","path":"CarePlan.activity.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"CarePlan.activity.extension","path":"CarePlan.activity.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"CarePlan.activity.modifierExtension","path":"CarePlan.activity.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"CarePlan.activity.performedActivity","path":"CarePlan.activity.performedActivity","short":"Results of the activity (concept, or Appointment, Encounter, Procedure, etc.)","definition":"Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using the CarePlan.activity.plannedActivityReference (a reference to a “request” resource).","comment":"Note that this should not duplicate the activity status (e.g. completed or in progress). The activity performed is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to exercise, then the activity performed could be amount and intensity of exercise performed whereas the goal outcome is an observation for the actual body weight measured.","requirements":"Links plan to resulting actions.","min":0,"max":"*","base":{"path":"CarePlan.activity.performedActivity","min":0,"max":"*"},"type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanActivityPerformed"}],"strength":"example","description":"Identifies the results of the activity.","valueSet":"http://hl7.org/fhir/ValueSet/care-plan-activity-performed"},"mapping":[{"identity":"workflow","map":"{Event that is outcome of Request in activity.plannedActivityReference}"},{"identity":"rim","map":".inboundRelationship[typeCode=FLFS].source"}]},{"id":"CarePlan.activity.progress","path":"CarePlan.activity.progress","short":"Comments about the activity status/progress","definition":"Notes about the adherence/status/progress of the activity.","comment":"This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.","requirements":"Can be used to capture information about adherence, progress, concerns, etc.","min":0,"max":"*","base":{"path":"CarePlan.activity.progress","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE?"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"}]},{"id":"CarePlan.activity.plannedActivityReference","path":"CarePlan.activity.plannedActivityReference","short":"Activity that is intended to be part of the care plan","definition":"The details of the proposed activity represented in a specific resource.","comment":"Standard extension exists ([http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal](http://hl7.org/fhir/extensions/StructureDefinition-resource-pertainsToGoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.plannedActivityReference. \nThe goal should be visible when the resource referenced by CarePlan.activity.plannedActivityReference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan.","requirements":"Details in a form consistent with other applications and contexts of use.","min":0,"max":"1","base":{"path":"CarePlan.activity.plannedActivityReference","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Appointment","http://hl7.org/fhir/StructureDefinition/CommunicationRequest","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/Task","http://hl7.org/fhir/StructureDefinition/ServiceRequest","http://hl7.org/fhir/StructureDefinition/VisionPrescription","http://hl7.org/fhir/StructureDefinition/RequestOrchestration","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/SupplyRequest"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"{Request that resulted in Event in activity.performedActivity}"},{"identity":"rim","map":".outboundRelationship[typeCode=COMP].target"}]},{"id":"CarePlan.note","path":"CarePlan.note","short":"Comments about the plan","definition":"General notes about the care plan not covered elsewhere.","requirements":"Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.","min":0,"max":"*","base":{"path":"CarePlan.note","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.note"},{"identity":"v2","map":"NTE?"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"}]}]},"differential":{"element":[{"id":"CarePlan","path":"CarePlan","short":"Healthcare plan for patient or group","definition":"Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.","alias":["Care Team"],"min":0,"max":"*","mustSupport":false,"isModifier":false,"mapping":[{"identity":"workflow","map":"Request"},{"identity":"w5","map":"clinical.careprovision"},{"identity":"rim","map":"Act[classCode=PCPR, moodCode=INT]"}]},{"id":"CarePlan.identifier","path":"CarePlan.identifier","short":"External Ids for this plan","definition":"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.","comment":"This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.","requirements":"Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PTH-3"},{"identity":"rim","map":".id"}]},{"id":"CarePlan.instantiatesCanonical","path":"CarePlan.instantiatesCanonical","short":"Instantiates FHIR protocol or definition","definition":"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.","min":0,"max":"*","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/PlanDefinition","http://hl7.org/fhir/StructureDefinition/Questionnaire","http://hl7.org/fhir/StructureDefinition/Measure","http://hl7.org/fhir/StructureDefinition/ActivityDefinition","http://hl7.org/fhir/StructureDefinition/OperationDefinition"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"CarePlan.instantiatesUri","path":"CarePlan.instantiatesUri","short":"Instantiates external protocol or definition","definition":"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.","comment":"This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.","min":0,"max":"*","type":[{"code":"uri"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.instantiatesUri"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"CarePlan.basedOn","path":"CarePlan.basedOn","short":"Fulfills plan, proposal or order","definition":"A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.","requirements":"Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.","alias":["fulfills"],"min":0,"max":"*","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/ServiceRequest","http://hl7.org/fhir/StructureDefinition/RequestOrchestration","http://hl7.org/fhir/StructureDefinition/NutritionOrder"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.basedOn"}]},{"id":"CarePlan.replaces","path":"CarePlan.replaces","short":"CarePlan replaced by this CarePlan","definition":"Completed or terminated care plan whose function is taken by this new care plan.","comment":"The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.","requirements":"Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.","alias":["supersedes"],"min":0,"max":"*","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.replaces"}]},{"id":"CarePlan.partOf","path":"CarePlan.partOf","short":"Part of referenced CarePlan","definition":"A larger care plan of which this particular care plan is a component or step.","comment":"Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.","min":0,"max":"*","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan"]}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"CarePlan.status","path":"CarePlan.status","short":"draft | active | on-hold | revoked | completed | entered-in-error | unknown","definition":"Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.","comment":"The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.","requirements":"Allows clinicians to determine whether the plan is actionable or not.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanStatus"}],"strength":"required","description":"Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.","valueSet":"http://hl7.org/fhir/ValueSet/request-status|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.status {uses different ValueSet}"},{"identity":"w5","map":"FiveWs.status"},{"identity":"v2","map":"PTH-5"},{"identity":"rim","map":".statusCode planned = new active = active completed = completed"}]},{"id":"CarePlan.intent","path":"CarePlan.intent","short":"proposal | plan | order | option | directive","definition":"Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.","comment":"This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.\nThis element is expected to be immutable. E.g. A \"proposal\" instance should never change to be a \"plan\" instance or \"order\" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.","requirements":"Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request\"","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanIntent"}],"strength":"required","description":"Codes indicating the degree of authority/intentionality associated with a care plan.","valueSet":"http://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.intent"}]},{"id":"CarePlan.category","path":"CarePlan.category","short":"Type of plan","definition":"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.","comment":"There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.addresses.","requirements":"Used for filtering what plan(s) are retrieved and displayed to different types of users.","min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanCategory"}],"strength":"example","description":"Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.","valueSet":"http://hl7.org/fhir/ValueSet/care-plan-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"}]},{"id":"CarePlan.title","path":"CarePlan.title","short":"Human-friendly name for the care plan","definition":"Human-friendly name for the care plan.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"CarePlan.description","path":"CarePlan.description","short":"Summary of nature of plan","definition":"A description of the scope and nature of the plan.","requirements":"Provides more detail than conveyed by category.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.what[x]"}]},{"id":"CarePlan.subject","path":"CarePlan.subject","short":"Who the care plan is for","definition":"Identifies the patient or group whose intended care is described by the plan.","alias":["patient"],"min":1,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":".participation[typeCode=PAT].role[classCode=PAT]"}]},{"id":"CarePlan.encounter","path":"CarePlan.encounter","short":"The Encounter during which this CarePlan was created","definition":"The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.","comment":"This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.encounter"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"Associated PV1"},{"identity":"rim","map":"."}]},{"id":"CarePlan.period","path":"CarePlan.period","short":"Time period plan covers","definition":"Indicates when the plan did (or is intended to) come into effect and end.","comment":"Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).","requirements":"Allows tracking what plan(s) are in effect at a particular time.","alias":["timing"],"min":0,"max":"1","type":[{"code":"Period"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.occurrence[x]"},{"identity":"w5","map":"FiveWs.planned"},{"identity":"v2","map":"GOL-7 / GOL-8"},{"identity":"rim","map":".effectiveTime"}]},{"id":"CarePlan.created","path":"CarePlan.created","short":"Date record was first recorded","definition":"Represents when this particular CarePlan record was created in the system, which is often a system-generated date.","alias":["authoredOn"],"min":0,"max":"1","type":[{"code":"dateTime"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.authoredOn"},{"identity":"w5","map":"FiveWs.recorded"},{"identity":"rim","map":".participation[typeCode=AUT].time"}]},{"id":"CarePlan.custodian","path":"CarePlan.custodian","short":"Who is the designated responsible party","definition":"When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.","comment":"The custodian might or might not be a contributor.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.requester"},{"identity":"w5","map":"FiveWs.author"}]},{"id":"CarePlan.contributor","path":"CarePlan.contributor","short":"Who provided the content of the care plan","definition":"Identifies the individual(s), organization or device who provided the contents of the care plan.","comment":"Collaborative care plans may have multiple contributors.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam"]}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"CarePlan.careTeam","path":"CarePlan.careTeam","short":"Who's involved in plan?","definition":"Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.","requirements":"Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CareTeam"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.performer {similar but does not entail CareTeam}"},{"identity":"w5","map":"FiveWs.actor"}]},{"id":"CarePlan.addresses","path":"CarePlan.addresses","short":"Health issues this plan addresses","definition":"Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.","comment":"Use CarePlan.addresses.concept when a code sufficiently describes the concern (e.g. condition, problem, diagnosis, risk). Use CarePlan.addresses.reference when referencing a resource, which allows more information to be conveyed, such as onset date. CarePlan.addresses.concept and CarePlan.addresses.reference are not meant to be duplicative. For a single concern, either CarePlan.addresses.concept or CarePlan.addresses.reference can be used. CarePlan.addresses.concept may be a summary code, or CarePlan.addresses.reference may be used to reference a very precise definition of the concern using Condition. Both CarePlan.addresses.concept and CarePlan.addresses.reference can be used if they are describing different concerns for the care plan.","requirements":"The element can identify risks addressed by the plan as well as concerns. Also scopes plans - multiple plans may exist addressing different concerns.","min":0,"max":"*","type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Condition"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanAddresses"}],"strength":"example","description":"Codes that describe the health issues this plan addresses.","valueSet":"http://hl7.org/fhir/ValueSet/clinical-findings"},"mapping":[{"identity":"workflow","map":"Request.reason"},{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"PRB-4"},{"identity":"rim","map":".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"}]},{"id":"CarePlan.supportingInfo","path":"CarePlan.supportingInfo","short":"Information considered as part of plan","definition":"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.","comment":"Use \"concern\" to identify specific conditions addressed by the care plan. supportingInfo can be used to convey one or more Advance Directives or Medical Treatment Consent Directives by referencing Consent or any other request resource with intent = directive.","requirements":"Identifies barriers and other considerations associated with the care plan.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.supportingInfo"}]},{"id":"CarePlan.goal","path":"CarePlan.goal","short":"Desired outcome of plan","definition":"Describes the intended objective(s) of carrying out the care plan.","comment":"Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.","requirements":"Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Goal"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"GOL-1"},{"identity":"rim","map":".outboundRelationship[typeCode<=OBJ]."}]},{"id":"CarePlan.activity","path":"CarePlan.activity","short":"Action to occur or has occurred as part of plan","definition":"Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.","requirements":"Allows systems to prompt for performance of planned activities, and validate plans against best practice.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"{no mapping\nNOTE: This is a list of contained Request-Event tuples!}"},{"identity":"rim","map":".outboundRelationship[typeCode=COMP].target"}]},{"id":"CarePlan.activity.performedActivity","path":"CarePlan.activity.performedActivity","short":"Results of the activity (concept, or Appointment, Encounter, Procedure, etc.)","definition":"Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using the CarePlan.activity.plannedActivityReference (a reference to a “request” resource).","comment":"Note that this should not duplicate the activity status (e.g. completed or in progress). The activity performed is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to exercise, then the activity performed could be amount and intensity of exercise performed whereas the goal outcome is an observation for the actual body weight measured.","requirements":"Links plan to resulting actions.","min":0,"max":"*","type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"CarePlanActivityPerformed"}],"strength":"example","description":"Identifies the results of the activity.","valueSet":"http://hl7.org/fhir/ValueSet/care-plan-activity-performed"},"mapping":[{"identity":"workflow","map":"{Event that is outcome of Request in activity.plannedActivityReference}"},{"identity":"rim","map":".inboundRelationship[typeCode=FLFS].source"}]},{"id":"CarePlan.activity.progress","path":"CarePlan.activity.progress","short":"Comments about the activity status/progress","definition":"Notes about the adherence/status/progress of the activity.","comment":"This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.","requirements":"Can be used to capture information about adherence, progress, concerns, etc.","min":0,"max":"*","type":[{"code":"Annotation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE?"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"}]},{"id":"CarePlan.activity.plannedActivityReference","path":"CarePlan.activity.plannedActivityReference","short":"Activity that is intended to be part of the care plan","definition":"The details of the proposed activity represented in a specific resource.","comment":"Standard extension exists ([http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal](http://hl7.org/fhir/extensions/StructureDefinition-resource-pertainsToGoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.plannedActivityReference. \nThe goal should be visible when the resource referenced by CarePlan.activity.plannedActivityReference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan.","requirements":"Details in a form consistent with other applications and contexts of use.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Appointment","http://hl7.org/fhir/StructureDefinition/CommunicationRequest","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/Task","http://hl7.org/fhir/StructureDefinition/ServiceRequest","http://hl7.org/fhir/StructureDefinition/VisionPrescription","http://hl7.org/fhir/StructureDefinition/RequestOrchestration","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/SupplyRequest"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"{Request that resulted in Event in activity.performedActivity}"},{"identity":"rim","map":".outboundRelationship[typeCode=COMP].target"}]},{"id":"CarePlan.note","path":"CarePlan.note","short":"Comments about the plan","definition":"General notes about the care plan not covered elsewhere.","requirements":"Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.","min":0,"max":"*","type":[{"code":"Annotation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.note"},{"identity":"v2","map":"NTE?"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CodeableReference.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CodeableReference.json index acb260340..52504dda7 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CodeableReference.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-CodeableReference.json @@ -1,251 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "CodeableReference", - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" CodeableReferenceΣDElementReference to a resource or a concept
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" conceptΣ0..1CodeableConceptReference to a concept (by class)
\".\"\".\"\".\" referenceΣ0..1Reference()Reference to a resource (by instance)

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "draft" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/CodeableReference", - "version" : "4.6.0", - "name" : "CodeableReference", - "status" : "draft", - "date" : "2021-04-15T12:25:09+10:00", - "publisher" : "HL7 FHIR Standard", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }], - "description" : "Base StructureDefinition for CodeableReference Type: A reference to a resource (by instance), or instead, a reference to a cencept defined in a terminology or ontology (by class).", - "purpose" : "This is a common pattern in record keeping - a reference may be made to a specific condition, observation, plan, or definition, or a reference may be made to a general concept defined in a knowledge base somewhere.", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }], - "kind" : "complex-type", - "abstract" : false, - "type" : "CodeableReference", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DataType", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "CodeableReference", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "draft" - }], - "path" : "CodeableReference", - "short" : "Reference to a resource or a concept", - "definition" : "A reference to a resource (by instance), or instead, a reference to a cencept defined in a terminology or ontology (by class).", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CodeableReference", - "min" : 0, - "max" : "*" - }, - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "CodeableReference.id", - "path" : "CodeableReference.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "CodeableReference.extension", - "path" : "CodeableReference.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "CodeableReference.concept", - "path" : "CodeableReference.concept", - "short" : "Reference to a concept (by class)", - "definition" : "A reference to a concept - e.g. the information is identified by it's general classto the degree of precision found in the terminology.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CodeableReference.concept", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "CodeableReference.reference", - "path" : "CodeableReference.reference", - "short" : "Reference to a resource (by instance)", - "definition" : "A reference to a resource the provides exact details about the information being referenced.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CodeableReference.reference", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "CodeableReference", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "draft" - }], - "path" : "CodeableReference", - "short" : "Reference to a resource or a concept", - "definition" : "A reference to a resource (by instance), or instead, a reference to a cencept defined in a terminology or ontology (by class).", - "min" : 0, - "max" : "*" - }, - { - "id" : "CodeableReference.concept", - "path" : "CodeableReference.concept", - "short" : "Reference to a concept (by class)", - "definition" : "A reference to a concept - e.g. the information is identified by it's general classto the degree of precision found in the terminology.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "CodeableReference.reference", - "path" : "CodeableReference.reference", - "short" : "Reference to a resource (by instance)", - "definition" : "A reference to a resource the provides exact details about the information being referenced.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference" - }], - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"CodeableReference","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n CodeableReference\n \n Σ\n D\n \n \n Element\n Reference to a resource or a concept\n
\n
Elements defined in Ancestors: \n id, \n extension\n
\n \".\"\n \".\"\n \".\" \n concept\n \n Σ\n 0..1\n CodeableConcept\n Reference to a concept (by class)\n
\n
\n \".\"\n \".\"\n \".\" \n reference\n \n Σ\n 0..1\n Reference()\n Reference to a resource (by instance)\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"draft"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"has-target"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"can-bind"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"do-translations"}],"url":"http://hl7.org/fhir/StructureDefinition/CodeableReference","version":"5.0.0","name":"CodeableReference","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"HL7 FHIR Standard","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]}],"description":"CodeableReference Type: A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"purpose":"This is a common pattern in record keeping - a reference may be made to a specific condition, observation, plan, or definition, or a reference may be made to a general concept defined in a knowledge base somewhere.","fhirVersion":"5.0.0","mapping":[{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"}],"kind":"complex-type","abstract":false,"type":"CodeableReference","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DataType","derivation":"specialization","snapshot":{"element":[{"id":"CodeableReference","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"draft"}],"path":"CodeableReference","short":"Reference to a resource or a concept","definition":"A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).","min":0,"max":"*","base":{"path":"CodeableReference","min":0,"max":"*"},"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"CodeableReference.id","path":"CodeableReference.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"CodeableReference.extension","path":"CodeableReference.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"CodeableReference.concept","path":"CodeableReference.concept","short":"Reference to a concept (by class)","definition":"A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.","min":0,"max":"1","base":{"path":"CodeableReference.concept","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"CodeableReference.reference","path":"CodeableReference.reference","short":"Reference to a resource (by instance)","definition":"A reference to a resource the provides exact details about the information being referenced.","min":0,"max":"1","base":{"path":"CodeableReference.reference","min":0,"max":"1"},"type":[{"code":"Reference"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]}]},"differential":{"element":[{"id":"CodeableReference","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"draft"}],"path":"CodeableReference","short":"Reference to a resource or a concept","definition":"A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).","min":0,"max":"*"},{"id":"CodeableReference.concept","path":"CodeableReference.concept","short":"Reference to a concept (by class)","definition":"A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"CodeableReference.reference","path":"CodeableReference.reference","short":"Reference to a resource (by instance)","definition":"A reference to a resource the provides exact details about the information being referenced.","min":0,"max":"1","type":[{"code":"Reference"}],"isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Condition.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Condition.json index 30aa77209..abdfd5859 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Condition.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Condition.json @@ -1,2542 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "Condition", - "meta" : { - "lastUpdated" : "2021-04-14T05:30:20.096+00:00" - }, - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Condition TUDomainResourceDetailed information about conditions, problems or diagnoses
+ Warning: If category is problems list item, the clinicalStatus should not be unknown
+ Rule: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission.
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier Σ0..*IdentifierExternal Ids for this condition
\".\"\".\"\".\" clinicalStatus ?!ΣI1..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Condition Clinical Status Codes (Required)
\".\"\".\"\".\" verificationStatus ?!Σ0..1CodeableConceptunconfirmed | provisional | differential | confirmed | refuted | entered-in-error
ConditionVerificationStatus (Required)
\".\"\".\"\".\" category I0..*CodeableConceptproblem-list-item | encounter-diagnosis
Condition Category Codes (Preferred)
\".\"\".\"\".\" severity 0..1CodeableConceptSubjective severity of condition
Condition/Diagnosis Severity (Preferred)
\".\"\".\"\".\" code Σ0..1CodeableConceptIdentification of the condition, problem or diagnosis
Condition/Problem/Diagnosis Codes (Example)
\".\"\".\"\".\" bodySite Σ0..*CodeableConceptAnatomical location, if relevant
SNOMED CT Body Structures (Example)
\".\"\".\"\".\" subject Σ1..1Reference(Patient | Group)Who has the condition?
\".\"\".\"\".\" encounter Σ0..1Reference(Encounter)The Encounter during which this Condition was created
\".\"\".\"\".\" onset[x] Σ0..1Estimated or actual date, date-time, or age
\".\"\".\"\".\"\".\" onsetDateTimedateTime
\".\"\".\"\".\"\".\" onsetAgeAge
\".\"\".\"\".\"\".\" onsetPeriodPeriod
\".\"\".\"\".\"\".\" onsetRangeRange
\".\"\".\"\".\"\".\" onsetStringstring
\".\"\".\"\".\" abatement[x] I0..1When in resolution/remission
\".\"\".\"\".\"\".\" abatementDateTimedateTime
\".\"\".\"\".\"\".\" abatementAgeAge
\".\"\".\"\".\"\".\" abatementPeriodPeriod
\".\"\".\"\".\"\".\" abatementRangeRange
\".\"\".\"\".\"\".\" abatementStringstring
\".\"\".\"\".\" recordedDate Σ0..1dateTimeDate record was first recorded
\".\"\".\"\".\" recorder Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the condition
\".\"\".\"\".\" asserter Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)Person or device that asserts this condition
\".\"\".\"\".\" stage I0..*BackboneElementStage/grade, usually assessed formally
+ Rule: Stage SHALL have summary or assessment
\".\"\".\"\".\"\".\" summary I0..1CodeableConceptSimple summary (disease specific)
Condition Stage (Example)
\".\"\".\"\".\"\".\" assessment I0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
\".\"\".\"\".\"\".\" type 0..1CodeableConceptKind of staging
Condition Stage Type (Example)
\".\"\".\"\".\" evidence I0..*BackboneElementSupporting evidence for the verification status
+ Rule: evidence SHALL have code or details
\".\"\".\"\".\"\".\" code ΣI0..*CodeableConceptManifestation/symptom
Manifestation and Symptom Codes (Example)
\".\"\".\"\".\"\".\" detail ΣI0..*Reference(Any)Supporting information found elsewhere
\".\"\".\"\".\" note 0..*AnnotationAdditional information about the Condition

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 3 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", - "valueCode" : "patient" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "pc" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/Condition", - "version" : "4.6.0", - "name" : "Condition", - "status" : "draft", - "date" : "2021-04-14T05:30:20+00:00", - "publisher" : "Health Level Seven International (Patient Care)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }, - { - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm" - }] - }], - "description" : "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "workflow", - "uri" : "http://hl7.org/fhir/workflow", - "name" : "Workflow Pattern" - }, - { - "identity" : "sct-concept", - "uri" : "http://snomed.info/conceptdomain", - "name" : "SNOMED CT Concept Domain Binding" - }, - { - "identity" : "v2", - "uri" : "http://hl7.org/v2", - "name" : "HL7 v2 Mapping" - }, - { - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }, - { - "identity" : "sct-attr", - "uri" : "http://snomed.org/attributebinding", - "name" : "SNOMED CT Attribute Binding" - }], - "kind" : "resource", - "abstract" : false, - "type" : "Condition", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "Condition", - "path" : "Condition", - "short" : "Detailed information about conditions, problems or diagnoses", - "definition" : "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition", - "min" : 0, - "max" : "*" - }, - "constraint" : [{ - "key" : "con-3", - "severity" : "warning", - "human" : "If category is problems list item, the clinicalStatus should not be unknown", - "expression" : "category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not()", - "xpath" : "not(exists(f:category/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-category' and f:code/@value='problem-list-item'])) or not(exists(f:clinicalStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-clinical' and f:code/@value='unknown']))", - "source" : "http://hl7.org/fhir/StructureDefinition/Condition" - }, - { - "key" : "con-4", - "severity" : "error", - "human" : "If condition is abated, then clinicalStatus must be either inactive, resolved, or remission.", - "expression" : "abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists())", - "xpath" : "not(exists(f:*[starts-with(local-name(.), 'abatement')])) or (not(exists(f:clinicalStatus)) or exists(f:clinicalStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-clinical' and f:code/@value=('inactive', 'resolved', 'remission')]))", - "source" : "http://hl7.org/fhir/StructureDefinition/Condition" - }, - { - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "workflow", - "map" : "Event" - }, - { - "identity" : "sct-concept", - "map" : "< 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)" - }, - { - "identity" : "v2", - "map" : "PPR message" - }, - { - "identity" : "rim", - "map" : "Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Condition.implicitRules", - "path" : "Condition.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "Condition.language", - "path" : "Condition.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "Condition.text", - "path" : "Condition.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "Condition.contained", - "path" : "Condition.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Condition.extension", - "path" : "Condition.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Condition.modifierExtension", - "path" : "Condition.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Condition.identifier", - "path" : "Condition.identifier", - "short" : "External Ids for this condition", - "definition" : "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.", - "comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.", - "requirements" : "Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "rim", - "map" : ".id" - }] - }, - { - "id" : "Condition.clinicalStatus", - "path" : "Condition.clinicalStatus", - "short" : "active | recurrence | relapse | inactive | remission | resolved", - "definition" : "The clinical status of the condition.", - "comment" : "The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. clinicalStatus is required since it is a modifier element. For conditions that are problems list items, the clinicalStatus should not be unknown. For conditions that are not problem list items, the clinicalStatus may be unknown. For example, conditions derived from a claim are point in time, so those conditions may have a clinicalStatus of unknown", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Condition.clinicalStatus", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["con-4", - "con-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the status contains codes that mark the condition as no longer active.", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ConditionClinicalStatus" - }], - "strength" : "required", - "description" : "The clinical status of the condition or diagnosis.", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-clinical|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.status" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "sct-concept", - "map" : "< 303105007 |Disease phases|" - }, - { - "identity" : "v2", - "map" : "PRB-14" - }, - { - "identity" : "rim", - "map" : "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value" - }] - }, - { - "id" : "Condition.verificationStatus", - "path" : "Condition.verificationStatus", - "short" : "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", - "definition" : "The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.", - "comment" : "verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.\nThe data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.verificationStatus", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the status contains the code refuted and entered-in-error that mark the Condition as not currently valid.", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ConditionVerificationStatus" - }], - "strength" : "required", - "description" : "The verification status to support or decline the clinical status of the condition or diagnosis.", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-ver-status|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.status" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "sct-concept", - "map" : "< 410514004 |Finding context value|" - }, - { - "identity" : "v2", - "map" : "PRB-13" - }, - { - "identity" : "rim", - "map" : "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value" - }, - { - "identity" : "sct-attr", - "map" : "408729009" - }] - }, - { - "id" : "Condition.category", - "path" : "Condition.category", - "short" : "problem-list-item | encounter-diagnosis", - "definition" : "A category assigned to the condition.", - "comment" : "The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["con-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ConditionCategory" - }], - "strength" : "preferred", - "description" : "A category assigned to the condition.", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "sct-concept", - "map" : "< 404684003 |Clinical finding|" - }, - { - "identity" : "v2", - "map" : "'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message" - }, - { - "identity" : "rim", - "map" : ".code" - }] - }, - { - "id" : "Condition.severity", - "path" : "Condition.severity", - "short" : "Subjective severity of condition", - "definition" : "A subjective assessment of the severity of the condition as evaluated by the clinician.", - "comment" : "Coding of the severity with a terminology is preferred, where possible.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.severity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ConditionSeverity" - }], - "strength" : "preferred", - "description" : "A subjective assessment of the severity of the condition as evaluated by the clinician.", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-severity" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.grade" - }, - { - "identity" : "sct-concept", - "map" : "< 272141005 |Severities|" - }, - { - "identity" : "v2", - "map" : "PRB-26 / ABS-3" - }, - { - "identity" : "rim", - "map" : "Can be pre/post-coordinated into value. Or ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"severity\"].value" - }, - { - "identity" : "sct-attr", - "map" : "246112005" - }] - }, - { - "id" : "Condition.code", - "path" : "Condition.code", - "short" : "Identification of the condition, problem or diagnosis", - "definition" : "Identification of the condition, problem or diagnosis.", - "requirements" : "0..1 to account for primarily narrative only resources.", - "alias" : ["type"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ConditionKind" - }], - "strength" : "example", - "description" : "Identification of the condition or diagnosis.", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-code" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.code" - }, - { - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "sct-concept", - "map" : "(< 404684003 |Clinical finding| MINUS (\n<< 420134006 |Propensity to adverse reactions| OR \n<< 473010000 |Hypersensitivity condition| OR \n<< 79899007 |Drug interaction| OR\n<< 69449002 |Drug action| OR \n<< 441742003 |Evaluation finding| OR \n<< 307824009 |Administrative status| OR \n<< 385356007 |Tumor stage finding|)) \nOR < 413350009 |Finding with explicit context|\nOR < 272379006 |Event|" - }, - { - "identity" : "v2", - "map" : "PRB-3" - }, - { - "identity" : "rim", - "map" : ".value" - }, - { - "identity" : "sct-attr", - "map" : "246090004" - }] - }, - { - "id" : "Condition.bodySite", - "path" : "Condition.bodySite", - "short" : "Anatomical location, if relevant", - "definition" : "The anatomical location where this condition manifests itself.", - "comment" : "Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.bodySite", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Codes describing anatomical locations. May include laterality." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodySite" - }], - "strength" : "example", - "description" : "SNOMED CT Body site concepts", - "valueSet" : "http://hl7.org/fhir/ValueSet/body-site" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 442083009 |Anatomical or acquired body structure|" - }, - { - "identity" : "rim", - "map" : ".targetBodySiteCode" - }, - { - "identity" : "sct-attr", - "map" : "363698007" - }] - }, - { - "id" : "Condition.subject", - "path" : "Condition.subject", - "short" : "Who has the condition?", - "definition" : "Indicates the patient or group who the condition record is associated with.", - "requirements" : "Group is typically used for veterinary or public health use cases.", - "alias" : ["patient"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "Condition.subject", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.subject" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=SBJ].role[classCode=PAT]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "Condition.encounter", - "path" : "Condition.encounter", - "short" : "The Encounter during which this Condition was created", - "definition" : "The Encounter during which this Condition was created or to which the creation of this record is tightly associated.", - "comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a \"new\" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first \"known\".", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.encounter", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.context" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "PV1-19 (+PV1-54)" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" - }] - }, - { - "id" : "Condition.onset[x]", - "path" : "Condition.onset[x]", - "short" : "Estimated or actual date, date-time, or age", - "definition" : "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "comment" : "Age is generally used when the patient reports an age at which the Condition began to occur. Period is generally used to convey an imprecise onset that occurred within the time period. For example, Period is not intended to convey the transition period before the chronic bronchitis or COPD condition was diagnosed, but Period can be used to convey an imprecise diagnosis date.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.onset[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }, - { - "code" : "Age" - }, - { - "code" : "Period" - }, - { - "code" : "Range" - }, - { - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.occurrence[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.init" - }, - { - "identity" : "v2", - "map" : "PRB-16" - }, - { - "identity" : "rim", - "map" : ".effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at onset\"].value" - }] - }, - { - "id" : "Condition.abatement[x]", - "path" : "Condition.abatement[x]", - "short" : "When in resolution/remission", - "definition" : "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\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", - "comment" : "There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.abatement[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }, - { - "code" : "Age" - }, - { - "code" : "Period" - }, - { - "code" : "Range" - }, - { - "code" : "string" - }], - "condition" : ["con-4"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.done[x]" - }, - { - "identity" : "rim", - "map" : ".effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at remission\"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed" - }] - }, - { - "id" : "Condition.recordedDate", - "path" : "Condition.recordedDate", - "short" : "Date record was first recorded", - "definition" : "The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.", - "comment" : "If the recordedDate is known via a sending system, it is preferred that the receiving system preserve the date. If the recorded date is not provided by the sending system, it is acceptable for the receiving system to assert their system-generated date.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.recordedDate", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "v2", - "map" : "REL-11" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].time" - }] - }, - { - "id" : "Condition.recorder", - "path" : "Condition.recorder", - "short" : "Who recorded the condition", - "definition" : "Individual who recorded the record and takes responsibility for its content.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.recorder", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.author" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].role" - }] - }, - { - "id" : "Condition.asserter", - "path" : "Condition.asserter", - "short" : "Person or device that asserts this condition", - "definition" : "Individual or device that is making the condition statement.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.asserter", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Device"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.source" - }, - { - "identity" : "v2", - "map" : "REL-7.1 identifier + REL-7.12 type code" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=INF].role" - }] - }, - { - "id" : "Condition.stage", - "path" : "Condition.stage", - "short" : "Stage/grade, usually assessed formally", - "definition" : "A simple summary of the stage such as \"Stage 3\" or \"Early Onset\". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.stage", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "con-1", - "severity" : "error", - "human" : "Stage SHALL have summary or assessment", - "expression" : "summary.exists() or assessment.exists()", - "xpath" : "exists(f:summary) or exists(f:assessment)", - "source" : "http://hl7.org/fhir/StructureDefinition/Condition" - }, - { - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage/grade\"]" - }] - }, - { - "id" : "Condition.stage.id", - "path" : "Condition.stage.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Condition.stage.extension", - "path" : "Condition.stage.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Condition.stage.modifierExtension", - "path" : "Condition.stage.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Condition.stage.summary", - "path" : "Condition.stage.summary", - "short" : "Simple summary (disease specific)", - "definition" : "A simple summary of the stage such as \"Stage 3\" or \"Early Onset\". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.stage.summary", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["con-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ConditionStage" - }], - "strength" : "example", - "description" : "Codes describing condition stages (e.g. Cancer stages).", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-stage" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 254291000 |Staging and scales|" - }, - { - "identity" : "v2", - "map" : "PRB-14" - }, - { - "identity" : "rim", - "map" : ".value" - }] - }, - { - "id" : "Condition.stage.assessment", - "path" : "Condition.stage.assessment", - "short" : "Formal record of assessment", - "definition" : "Reference to a formal record of the evidence on which the staging assessment is based.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.stage.assessment", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClinicalImpression", - "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", - "http://hl7.org/fhir/StructureDefinition/Observation"] - }], - "condition" : ["con-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".self" - }] - }, - { - "id" : "Condition.stage.type", - "path" : "Condition.stage.type", - "short" : "Kind of staging", - "definition" : "The kind of staging, such as pathological or clinical staging.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Condition.stage.type", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ConditionStageType" - }], - "strength" : "example", - "description" : "Codes describing the kind of condition staging (e.g. clinical or pathological).", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-stage-type" - }, - "mapping" : [{ - "identity" : "rim", - "map" : "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage type\"]" - }] - }, - { - "id" : "Condition.evidence", - "path" : "Condition.evidence", - "short" : "Supporting evidence for the verification status", - "definition" : "Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", - "comment" : "If the condition was confirmed, but subsequently refuted, then the evidence can be cumulative including all evidence over time. The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.evidence", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "con-2", - "severity" : "error", - "human" : "evidence SHALL have code or details", - "expression" : "code.exists() or detail.exists()", - "xpath" : "exists(f:code) or exists(f:detail)", - "source" : "http://hl7.org/fhir/StructureDefinition/Condition" - }, - { - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]" - }] - }, - { - "id" : "Condition.evidence.id", - "path" : "Condition.evidence.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Condition.evidence.extension", - "path" : "Condition.evidence.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Condition.evidence.modifierExtension", - "path" : "Condition.evidence.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Condition.evidence.code", - "path" : "Condition.evidence.code", - "short" : "Manifestation/symptom", - "definition" : "A manifestation or symptom that led to the recording of this condition.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.evidence.code", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["con-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ManifestationOrSymptom" - }], - "strength" : "example", - "description" : "Codes that describe the manifestation or symptoms of a condition.", - "valueSet" : "http://hl7.org/fhir/ValueSet/manifestation-or-symptom" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.reasonCode" - }, - { - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "sct-concept", - "map" : "< 404684003 |Clinical finding|" - }, - { - "identity" : "rim", - "map" : "[code=\"diagnosis\"].value" - }] - }, - { - "id" : "Condition.evidence.detail", - "path" : "Condition.evidence.detail", - "short" : "Supporting information found elsewhere", - "definition" : "Links to other relevant information, including pathology reports.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.evidence.detail", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "condition" : ["con-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "rim", - "map" : ".self" - }] - }, - { - "id" : "Condition.note", - "path" : "Condition.note", - "short" : "Additional information about the Condition", - "definition" : "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Condition.note", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.note" - }, - { - "identity" : "v2", - "map" : "NTE child of PRB" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "Condition", - "path" : "Condition", - "short" : "Detailed information about conditions, problems or diagnoses", - "definition" : "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", - "min" : 0, - "max" : "*", - "constraint" : [{ - "key" : "con-4", - "severity" : "error", - "human" : "If condition is abated, then clinicalStatus must be either inactive, resolved, or remission.", - "expression" : "abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists())", - "xpath" : "not(exists(f:*[starts-with(local-name(.), 'abatement')])) or (not(exists(f:clinicalStatus)) or exists(f:clinicalStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-clinical' and f:code/@value=('inactive', 'resolved', 'remission')]))", - "source" : "http://hl7.org/fhir/StructureDefinition/Condition" - }, - { - "key" : "con-3", - "severity" : "warning", - "human" : "If category is problems list item, the clinicalStatus should not be unknown", - "expression" : "category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not()", - "xpath" : "not(exists(f:category/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-category' and f:code/@value='problem-list-item'])) or not(exists(f:clinicalStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-clinical' and f:code/@value='unknown']))", - "source" : "http://hl7.org/fhir/StructureDefinition/Condition" - }], - "mustSupport" : false, - "isModifier" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event" - }, - { - "identity" : "sct-concept", - "map" : "< 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)" - }, - { - "identity" : "v2", - "map" : "PPR message" - }, - { - "identity" : "rim", - "map" : "Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Condition\n \n \n TU\n \n \n DomainResource\n Detailed information about conditions, problems or diagnoses\n
\n + Warning: If category is problems list item, the clinicalStatus should not be unknown\n
\n + Rule: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission.\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n 0..*\n Identifier\n External Ids for this condition\n
\n
\n
\n \".\"\n \".\"\n \".\" \n clinicalStatus\n \n \n ?!\n Σ\n C\n 1..1\n CodeableConcept\n active | recurrence | relapse | inactive | remission | resolved | unknown\n
Binding: \n Condition Clinical Status Codes (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n verificationStatus\n \n \n ?!\n Σ\n 0..1\n CodeableConcept\n unconfirmed | provisional | differential | confirmed | refuted | entered-in-error\n
Binding: \n Condition Verification Status (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n category\n \n \n C\n 0..*\n CodeableConcept\n problem-list-item | encounter-diagnosis\n
Binding: \n Condition Category Codes (\n Preferred)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n severity\n \n \n 0..1\n CodeableConcept\n Subjective severity of condition\n
Binding: \n Condition/Diagnosis Severity (\n Preferred)\n
\n
\n \".\"\n \".\"\n \".\" \n code\n \n \n Σ\n 0..1\n CodeableConcept\n Identification of the condition, problem or diagnosis\n
Binding: \n Condition/Problem/Diagnosis Codes (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n bodySite\n \n \n Σ\n 0..*\n CodeableConcept\n Anatomical location, if relevant\n
Binding: \n SNOMED CT Body Structures (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n subject\n \n \n Σ\n 1..1\n Reference(\n Patient | \n Group)\n Who has the condition?\n
\n
\n \".\"\n \".\"\n \".\" \n encounter\n \n \n Σ\n 0..1\n Reference(\n Encounter)\n The Encounter during which this Condition was created\n
\n
\n \".\"\n \".\"\n \".\" \n onset[x]\n \n \n Σ\n 0..1\n Estimated or actual date, date-time, or age\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n onsetDateTime\n \n \n \n dateTime\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n onsetAge\n \n \n \n Age\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n onsetPeriod\n \n \n \n Period\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n onsetRange\n \n \n \n Range\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n onsetString\n \n \n \n string\n \n
\n \".\"\n \".\"\n \".\" \n abatement[x]\n \n \n C\n 0..1\n When in resolution/remission\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n abatementDateTime\n \n \n \n dateTime\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n abatementAge\n \n \n \n Age\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n abatementPeriod\n \n \n \n Period\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n abatementRange\n \n \n \n Range\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n abatementString\n \n \n \n string\n \n
\n \".\"\n \".\"\n \".\" \n recordedDate\n \n \n Σ\n 0..1\n dateTime\n Date condition was first recorded\n
\n
\n \".\"\n \".\"\n \".\" \n participant\n \n \n Σ\n 0..*\n BackboneElement\n Who or what participated in the activities related to the condition and how they were involved\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n function\n \n \n Σ\n 0..1\n CodeableConcept\n Type of involvement\n
Binding: \n Participation Role Type (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n actor\n \n \n Σ\n 1..1\n Reference(\n Practitioner | \n PractitionerRole | \n Patient | \n RelatedPerson | \n Device | \n Organization | \n CareTeam)\n Who or what participated in the activities related to the condition\n
\n
\n \".\"\n \".\"\n \".\" \n stage\n \n \n C\n TU\n 0..*\n BackboneElement\n Stage/grade, usually assessed formally\n
\n + Rule: Stage SHALL have summary or assessment\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n summary\n \n \n C\n 0..1\n CodeableConcept\n Simple summary (disease specific)\n
Binding: \n Condition Stage (\n Example)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n assessment\n \n \n C\n 0..*\n Reference(\n ClinicalImpression | \n DiagnosticReport | \n Observation)\n Formal record of assessment\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n type\n \n \n 0..1\n CodeableConcept\n Kind of staging\n
Binding: \n Condition Stage Type (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n evidence\n \n \n Σ\n TU\n 0..*\n CodeableReference(\n Any)\n Supporting evidence for the verification status\n
Binding: \n SNOMED CT Clinical Findings (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n note\n \n \n 0..*\n Annotation\n Additional information about the Condition\n
\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n "},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Clinical.Summary"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pc"}],"url":"http://hl7.org/fhir/StructureDefinition/Condition","version":"5.0.0","name":"Condition","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (Patient Care)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/patientcare/index.cfm"}]}],"description":"A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"sct-concept","uri":"http://snomed.info/conceptdomain","name":"SNOMED CT Concept Domain Binding"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"sct-attr","uri":"http://snomed.org/attributebinding","name":"SNOMED CT Attribute Binding"}],"kind":"resource","abstract":false,"type":"Condition","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"Condition","path":"Condition","short":"Detailed information about conditions, problems or diagnoses","definition":"A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.","min":0,"max":"*","base":{"path":"Condition","min":0,"max":"*"},"constraint":[{"key":"con-2","severity":"warning","human":"If category is problems list item, the clinicalStatus should not be unknown","expression":"category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not()","source":"http://hl7.org/fhir/StructureDefinition/Condition"},{"key":"con-3","severity":"error","human":"If condition is abated, then clinicalStatus must be either inactive, resolved, or remission.","expression":"abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists())","source":"http://hl7.org/fhir/StructureDefinition/Condition"},{"key":"dom-2","severity":"error","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","expression":"contained.contained.empty()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Condition.implicitRules","path":"Condition.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Condition.language","path":"Condition.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Condition.text","path":"Condition.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Condition.contained","path":"Condition.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Condition.extension","path":"Condition.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Condition.modifierExtension","path":"Condition.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Condition.identifier","path":"Condition.identifier","short":"External Ids for this condition","definition":"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.","comment":"This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.","requirements":"Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers.","min":0,"max":"*","base":{"path":"Condition.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"rim","map":".id"}]},{"id":"Condition.clinicalStatus","path":"Condition.clinicalStatus","short":"active | recurrence | relapse | inactive | remission | resolved | unknown","definition":"The clinical status of the condition.","comment":"The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. clinicalStatus is required since it is a modifier element. For conditions that are problems list items, the clinicalStatus should not be unknown. For conditions that are not problem list items, the clinicalStatus may be unknown. For example, conditions derived from a claim are point in time, so those conditions may have a clinicalStatus of unknown","min":1,"max":"1","base":{"path":"Condition.clinicalStatus","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["con-3","con-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the status contains codes that mark the condition as no longer active.","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionClinicalStatus"}],"strength":"required","description":"The clinical status of the condition or diagnosis.","valueSet":"http://hl7.org/fhir/ValueSet/condition-clinical|5.0.0"},"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 303105007 |Disease phases|"},{"identity":"v2","map":"PRB-14"},{"identity":"rim","map":"Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value"}]},{"id":"Condition.verificationStatus","path":"Condition.verificationStatus","short":"unconfirmed | provisional | differential | confirmed | refuted | entered-in-error","definition":"The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.","comment":"verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.\nThe data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.","min":0,"max":"1","base":{"path":"Condition.verificationStatus","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the status contains the code refuted and entered-in-error that mark the Condition as not currently valid.","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionVerificationStatus"}],"strength":"required","description":"The verification status to support or decline the clinical status of the condition or diagnosis.","valueSet":"http://hl7.org/fhir/ValueSet/condition-ver-status|5.0.0"},"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 410514004 |Finding context value|"},{"identity":"v2","map":"PRB-13"},{"identity":"rim","map":"Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value"},{"identity":"sct-attr","map":"408729009"}]},{"id":"Condition.category","path":"Condition.category","short":"problem-list-item | encounter-diagnosis","definition":"A category assigned to the condition.","comment":"The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.","min":0,"max":"*","base":{"path":"Condition.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"condition":["con-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionCategory"}],"strength":"preferred","description":"A category assigned to the condition.","valueSet":"http://hl7.org/fhir/ValueSet/condition-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"sct-concept","map":"< 404684003 |Clinical finding|"},{"identity":"v2","map":"'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message"},{"identity":"rim","map":".code"}]},{"id":"Condition.severity","path":"Condition.severity","short":"Subjective severity of condition","definition":"A subjective assessment of the severity of the condition as evaluated by the clinician.","comment":"Coding of the severity with a terminology is preferred, where possible.","min":0,"max":"1","base":{"path":"Condition.severity","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionSeverity"}],"strength":"preferred","description":"A subjective assessment of the severity of the condition as evaluated by the clinician.","valueSet":"http://hl7.org/fhir/ValueSet/condition-severity"},"mapping":[{"identity":"w5","map":"FiveWs.grade"},{"identity":"sct-concept","map":"< 272141005 |Severities|"},{"identity":"v2","map":"PRB-26 / ABS-3"},{"identity":"rim","map":"Can be pre/post-coordinated into value. Or ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"severity\"].value"},{"identity":"sct-attr","map":"246112005"}]},{"id":"Condition.code","path":"Condition.code","short":"Identification of the condition, problem or diagnosis","definition":"Identification of the condition, problem or diagnosis.","requirements":"0..1 to account for primarily narrative only resources.","alias":["type"],"min":0,"max":"1","base":{"path":"Condition.code","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionKind"}],"strength":"example","description":"Identification of the condition or diagnosis.","valueSet":"http://hl7.org/fhir/ValueSet/condition-code"},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"(< 404684003 |Clinical finding| MINUS (\n<< 420134006 |Propensity to adverse reactions| OR \n<< 473010000 |Hypersensitivity condition| OR \n<< 79899007 |Drug interaction| OR\n<< 69449002 |Drug action| OR \n<< 441742003 |Evaluation finding| OR \n<< 307824009 |Administrative status| OR \n<< 385356007 |Tumor stage finding|)) \nOR < 413350009 |Finding with explicit context|\nOR < 272379006 |Event|"},{"identity":"v2","map":"PRB-3"},{"identity":"rim","map":".value"},{"identity":"sct-attr","map":"246090004"}]},{"id":"Condition.bodySite","path":"Condition.bodySite","short":"Anatomical location, if relevant","definition":"The anatomical location where this condition manifests itself.","comment":"Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodyStructure resource (e.g. to identify and track separately) then use the standard extension [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both.","min":0,"max":"*","base":{"path":"Condition.bodySite","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","description":"SNOMED CT Body site concepts","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"mapping":[{"identity":"sct-concept","map":"< 442083009 |Anatomical or acquired body structure|"},{"identity":"rim","map":".targetBodySiteCode"},{"identity":"sct-attr","map":"363698007"}]},{"id":"Condition.subject","path":"Condition.subject","short":"Who has the condition?","definition":"Indicates the patient or group who the condition record is associated with.","requirements":"Group is typically used for veterinary or public health use cases.","alias":["patient"],"min":1,"max":"1","base":{"path":"Condition.subject","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":".participation[typeCode=SBJ].role[classCode=PAT]"}]},{"id":"Condition.encounter","path":"Condition.encounter","short":"The Encounter during which this Condition was created","definition":"The Encounter during which this Condition was created or to which the creation of this record is tightly associated.","comment":"This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a \"new\" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first \"known\".","min":0,"max":"1","base":{"path":"Condition.encounter","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1-19 (+PV1-54)"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]},{"id":"Condition.onset[x]","path":"Condition.onset[x]","short":"Estimated or actual date, date-time, or age","definition":"Estimated or actual date or date-time the condition began, in the opinion of the clinician.","comment":"Age is generally used when the patient reports an age at which the Condition began to occur. Period is generally used to convey an imprecise onset that occurred within the time period. For example, Period is not intended to convey the transition period before the chronic bronchitis or COPD condition was diagnosed, but Period can be used to convey an imprecise diagnosis date. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old). Because a Condition.code can represent multiple levels of granularity and can be modified over time, the onset and abatement dates can have ambiguity whether those dates apply to the current Condition.code or an earlier representation of that Condition.code. For example, if the Condition.code was initially documented as severe asthma, then it is ambiguous whether the onset and abatement dates apply to asthma (overall in that subject's lifetime) or when asthma transitioned to become severe.","min":0,"max":"1","base":{"path":"Condition.onset[x]","min":0,"max":"1"},"type":[{"code":"dateTime"},{"code":"Age"},{"code":"Period"},{"code":"Range"},{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.init"},{"identity":"v2","map":"PRB-16"},{"identity":"rim","map":".effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at onset\"].value"}]},{"id":"Condition.abatement[x]","path":"Condition.abatement[x]","short":"When in resolution/remission","definition":"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\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.","comment":"There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated.\nBecause a Condition.code can represent multiple levels of granularity and can be modified over time, the onset and abatement dates can have ambiguity whether those dates apply to the current Condition.code or an earlier representation of that Condition.code. For example, if the Condition.code was initially documented as severe asthma, then it is ambiguous whether the onset and abatement dates apply to asthma (overall in that subject's lifetime) or when asthma transitioned to become severe.","min":0,"max":"1","base":{"path":"Condition.abatement[x]","min":0,"max":"1"},"type":[{"code":"dateTime"},{"code":"Age"},{"code":"Period"},{"code":"Range"},{"code":"string"}],"condition":["con-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"rim","map":".effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at remission\"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed"}]},{"id":"Condition.recordedDate","path":"Condition.recordedDate","short":"Date condition was first recorded","definition":"The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.","comment":"When onset date is unknown, recordedDate can be used to establish if the condition was present on or before a given date. If the recordedDate is known and provided by a sending system, it is preferred that the receiving system preserve that recordedDate value. If the recordedDate is not provided by the sending system, the receipt timestamp is sometimes used as the recordedDate.","min":0,"max":"1","base":{"path":"Condition.recordedDate","min":0,"max":"1"},"type":[{"code":"dateTime"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"REL-11"},{"identity":"rim","map":".participation[typeCode=AUT].time"}]},{"id":"Condition.participant","path":"Condition.participant","short":"Who or what participated in the activities related to the condition and how they were involved","definition":"Indicates who or what participated in the activities related to the condition and how they were involved.","min":0,"max":"*","base":{"path":"Condition.participant","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":".participation[typeCode=PRF]"}]},{"id":"Condition.participant.id","path":"Condition.participant.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Condition.participant.extension","path":"Condition.participant.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Condition.participant.modifierExtension","path":"Condition.participant.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Condition.participant.function","path":"Condition.participant.function","short":"Type of involvement","definition":"Distinguishes the type of involvement of the actor in the activities related to the condition.","min":0,"max":"1","base":{"path":"Condition.participant.function","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionParticipantFunction"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/participation-role-type"},"mapping":[{"identity":"rim","map":".participation.functionCode"}]},{"id":"Condition.participant.actor","path":"Condition.participant.actor","short":"Who or what participated in the activities related to the condition","definition":"Indicates who or what participated in the activities related to the condition.","min":1,"max":"1","base":{"path":"Condition.participant.actor","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.who"},{"identity":"rim","map":".player"}]},{"id":"Condition.stage","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Condition.stage","short":"Stage/grade, usually assessed formally","definition":"A simple summary of the stage such as \"Stage 3\" or \"Early Onset\". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.","min":0,"max":"*","base":{"path":"Condition.stage","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"con-1","severity":"error","human":"Stage SHALL have summary or assessment","expression":"summary.exists() or assessment.exists()","source":"http://hl7.org/fhir/StructureDefinition/Condition"},{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage/grade\"]"}]},{"id":"Condition.stage.id","path":"Condition.stage.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Condition.stage.extension","path":"Condition.stage.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Condition.stage.modifierExtension","path":"Condition.stage.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Condition.stage.summary","path":"Condition.stage.summary","short":"Simple summary (disease specific)","definition":"A simple summary of the stage such as \"Stage 3\" or \"Early Onset\". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.","min":0,"max":"1","base":{"path":"Condition.stage.summary","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["con-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionStage"}],"strength":"example","description":"Codes describing condition stages (e.g. Cancer stages).","valueSet":"http://hl7.org/fhir/ValueSet/condition-stage"},"mapping":[{"identity":"sct-concept","map":"< 254291000 |Staging and scales|"},{"identity":"v2","map":"PRB-14"},{"identity":"rim","map":".value"}]},{"id":"Condition.stage.assessment","path":"Condition.stage.assessment","short":"Formal record of assessment","definition":"Reference to a formal record of the evidence on which the staging assessment is based.","min":0,"max":"*","base":{"path":"Condition.stage.assessment","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ClinicalImpression","http://hl7.org/fhir/StructureDefinition/DiagnosticReport","http://hl7.org/fhir/StructureDefinition/Observation"]}],"condition":["con-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".self"}]},{"id":"Condition.stage.type","path":"Condition.stage.type","short":"Kind of staging","definition":"The kind of staging, such as pathological or clinical staging.","min":0,"max":"1","base":{"path":"Condition.stage.type","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ConditionStageType"}],"strength":"example","description":"Codes describing the kind of condition staging (e.g. clinical or pathological).","valueSet":"http://hl7.org/fhir/ValueSet/condition-stage-type"},"mapping":[{"identity":"rim","map":"./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage type\"]"}]},{"id":"Condition.evidence","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Condition.evidence","short":"Supporting evidence for the verification status","definition":"Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.","comment":"If the condition was confirmed, but subsequently refuted, then the evidence can be cumulative including all evidence over time. The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both. For example, if the Condition.code is pneumonia, then there could be an evidence list where Condition.evidence.concept = fever (CodeableConcept), Condition.evidence.concept = cough (CodeableConcept), and Condition.evidence.reference = bronchitis (reference to Condition). ","min":0,"max":"*","base":{"path":"Condition.evidence","min":0,"max":"*"},"type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ManifestationOrSymptom"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/clinical-findings"},"mapping":[{"identity":"rim","map":".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]"}]},{"id":"Condition.note","path":"Condition.note","short":"Additional information about the Condition","definition":"Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.","min":0,"max":"*","base":{"path":"Condition.note","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE child of PRB"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"}]}]},"differential":{"element":[{"id":"Condition","path":"Condition","short":"Detailed information about conditions, problems or diagnoses","definition":"A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.","min":0,"max":"*","constraint":[{"key":"con-2","severity":"warning","human":"If category is problems list item, the clinicalStatus should not be unknown","expression":"category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not()","source":"http://hl7.org/fhir/StructureDefinition/Condition"},{"key":"con-3","severity":"error","human":"If condition is abated, then clinicalStatus must be either inactive, resolved, or remission.","expression":"abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists())","source":"http://hl7.org/fhir/StructureDefinition/Condition"}],"mustSupport":false,"isModifier":false,"mapping":[{"identity":"w5","map":"clinical.general"},{"identity":"sct-concept","map":"< 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)"},{"identity":"v2","map":"PPR message"},{"identity":"rim","map":"Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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.","id":"DomainResource.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"DomainResource.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","id":"DomainResource.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"DomainResource.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The base language in which the resource is written.","id":"DomainResource.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"DomainResource.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"Contained resources do not have a 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 information is added later.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"DomainResource.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"mustSupport":false,"path":"DomainResource.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.","definition":"These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.","id":"DomainResource.contained","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"DomainResource.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"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.","id":"DomainResource.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"DomainResource.extension","short":"Additional content defined by implementations","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"DomainResource.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"DomainResource.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" DomainResource «I»NResourceA resource with narrative, extensions, and contained resources
+ Rule: If the resource is contained in another resource, it SHALL NOT contain nested Resources
+ Rule: 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
+ Rule: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
+ Rule: If a resource is contained in another resource, it SHALL NOT have a security label
+ Guideline: A resource should have narrative for robust management
Elements defined in Ancestors: id, meta, implicitRules, language
\".\"\".\"\".\" text 0..1NarrativeText summary of the resource, for human interpretation
\".\"\".\"\".\" contained 0..*ResourceContained, inline Resources
\".\"\".\"\".\" extension 0..*ExtensionAdditional content defined by implementations
\".\"\".\"\".\" modifierExtension ?!0..*ExtensionExtensions that cannot be ignored

\"doco\" Documentation for this format
","status":"generated"},"type":"DomainResource","url":"http://hl7.org/fhir/StructureDefinition/DomainResource","version":"4.6.0"} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"DomainResource","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n DomainResource\n \n \n «A»\n N\n \n \n Resource\n A resource with narrative, extensions, and contained resources\n
\n + Rule: If the resource is contained in another resource, it SHALL NOT contain nested Resources\n
\n + Rule: 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\n
\n + Rule: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated\n
\n + Rule: If a resource is contained in another resource, it SHALL NOT have a security label\n
\n + Guideline: A resource should have narrative for robust management\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language\n
\n \".\"\n \".\"\n \".\" \n text\n \n \n C\n 0..1\n Narrative\n Text summary of the resource, for human interpretation\n
\n
\n \".\"\n \".\"\n \".\" \n contained\n \n \n C\n 0..*\n Resource\n Contained, inline Resources\n
\n
\n
\n \".\"\n \".\"\n \".\" \n extension\n \n \n 0..*\n Extension\n Additional content defined by implementations\n
\n
\n
\n \".\"\n \".\"\n \".\" \n modifierExtension\n \n \n ?!\n Σ\n 0..*\n Extension\n Extensions that cannot be ignored\n
\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"url":"http://hl7.org/fhir/StructureDefinition/DomainResource","version":"5.0.0","name":"DomainResource","status":"active","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (FHIR Infrastructure)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg/index.cfm"}]}],"description":"A resource that includes narrative, extensions, and contained resources.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"}],"kind":"resource","abstract":true,"type":"DomainResource","baseDefinition":"http://hl7.org/fhir/StructureDefinition/Resource","derivation":"specialization","snapshot":{"element":[{"id":"DomainResource","path":"DomainResource","short":"A resource with narrative, extensions, and contained resources","definition":"A resource that includes narrative, extensions, and contained resources.","min":0,"max":"*","base":{"path":"DomainResource","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act,Entity, Role, or Act"}]},{"id":"DomainResource.id","path":"DomainResource.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"DomainResource.meta","path":"DomainResource.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"DomainResource.implicitRules","path":"DomainResource.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"DomainResource.language","path":"DomainResource.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"DomainResource.text","path":"DomainResource.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"DomainResource.contained","path":"DomainResource.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"DomainResource.extension","path":"DomainResource.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"DomainResource.modifierExtension","path":"DomainResource.modifierExtension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]}]},"differential":{"element":[{"id":"DomainResource","path":"DomainResource","short":"A resource with narrative, extensions, and contained resources","definition":"A resource that includes narrative, extensions, and contained resources.","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()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act"}]},{"id":"DomainResource.text","path":"DomainResource.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information is added later.","alias":["narrative","html","xhtml","display"],"min":0,"max":"1","type":[{"code":"Narrative"}],"condition":["dom-6"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"DomainResource.contained","path":"DomainResource.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"DomainResource.extension","path":"DomainResource.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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":"*","type":[{"code":"Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"DomainResource.modifierExtension","path":"DomainResource.modifierExtension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","type":[{"code":"Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Extension.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Extension.json index 1cd59e6ad..a35969b23 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Extension.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Extension.json @@ -1,595 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "Extension", - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" ExtensionNElementOptional Extensions Element
+ Rule: Must have either extensions or value[x], not both
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" url1..1uriidentifies the meaning of the extension
\".\"\".\"\".\" value[x]0..1*Value of extension

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "normative" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", - "valueCode" : "4.0.0" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/Extension", - "version" : "4.6.0", - "name" : "Extension", - "status" : "active", - "date" : "2021-04-15T12:25:09+10:00", - "publisher" : "HL7 FHIR Standard", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }], - "description" : "Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.", - "purpose" : "The ability to add extensions in a structured way is what keeps FHIR resources simple.", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }], - "kind" : "complex-type", - "abstract" : false, - "type" : "Extension", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DataType", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "Extension", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "normative" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", - "valueCode" : "4.0.0" - }], - "path" : "Extension", - "short" : "Optional Extensions Element", - "definition" : "Optional Extension Element - found in all resources.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Extension", - "min" : 0, - "max" : "*" - }, - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }, - { - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Extension.id", - "path" : "Extension.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Extension.extension", - "path" : "Extension.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Extension.url", - "path" : "Extension.url", - "representation" : ["xmlAttr"], - "short" : "identifies the meaning of the extension", - "definition" : "Source of the definition for the extension code - a logical name or a URL.", - "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Extension.url", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "uri" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Extension.value[x]", - "path" : "Extension.value[x]", - "short" : "Value of extension", - "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Extension.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "base64Binary" - }, - { - "code" : "boolean" - }, - { - "code" : "canonical" - }, - { - "code" : "code" - }, - { - "code" : "date" - }, - { - "code" : "dateTime" - }, - { - "code" : "decimal" - }, - { - "code" : "id" - }, - { - "code" : "instant" - }, - { - "code" : "integer" - }, - { - "code" : "integer64" - }, - { - "code" : "markdown" - }, - { - "code" : "oid" - }, - { - "code" : "positiveInt" - }, - { - "code" : "string" - }, - { - "code" : "time" - }, - { - "code" : "unsignedInt" - }, - { - "code" : "uri" - }, - { - "code" : "url" - }, - { - "code" : "uuid" - }, - { - "code" : "Address" - }, - { - "code" : "Age" - }, - { - "code" : "Annotation" - }, - { - "code" : "Attachment" - }, - { - "code" : "CodeableConcept" - }, - { - "code" : "CodeableReference" - }, - { - "code" : "Coding" - }, - { - "code" : "ContactPoint" - }, - { - "code" : "Count" - }, - { - "code" : "Distance" - }, - { - "code" : "Duration" - }, - { - "code" : "HumanName" - }, - { - "code" : "Identifier" - }, - { - "code" : "Money" - }, - { - "code" : "Period" - }, - { - "code" : "Quantity" - }, - { - "code" : "Range" - }, - { - "code" : "Ratio" - }, - { - "code" : "Reference" - }, - { - "code" : "SampledData" - }, - { - "code" : "Signature" - }, - { - "code" : "Timing" - }, - { - "code" : "ContactDetail" - }, - { - "code" : "Contributor" - }, - { - "code" : "DataRequirement" - }, - { - "code" : "Expression" - }, - { - "code" : "ParameterDefinition" - }, - { - "code" : "RelatedArtifact" - }, - { - "code" : "TriggerDefinition" - }, - { - "code" : "UsageContext" - }, - { - "code" : "Dosage" - }, - { - "code" : "Meta" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "Extension", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "normative" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", - "valueCode" : "4.0.0" - }], - "path" : "Extension", - "short" : "Optional Extensions Element", - "definition" : "Optional Extension Element - found in all resources.", - "min" : 0, - "max" : "*", - "constraint" : [{ - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Extension.url", - "path" : "Extension.url", - "representation" : ["xmlAttr"], - "short" : "identifies the meaning of the extension", - "definition" : "Source of the definition for the extension code - a logical name or a URL.", - "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", - "min" : 1, - "max" : "1", - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "uri" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Extension.value[x]", - "path" : "Extension.value[x]", - "short" : "Value of extension", - "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "base64Binary" - }, - { - "code" : "boolean" - }, - { - "code" : "canonical" - }, - { - "code" : "code" - }, - { - "code" : "date" - }, - { - "code" : "dateTime" - }, - { - "code" : "decimal" - }, - { - "code" : "id" - }, - { - "code" : "instant" - }, - { - "code" : "integer" - }, - { - "code" : "integer64" - }, - { - "code" : "markdown" - }, - { - "code" : "oid" - }, - { - "code" : "positiveInt" - }, - { - "code" : "string" - }, - { - "code" : "time" - }, - { - "code" : "unsignedInt" - }, - { - "code" : "uri" - }, - { - "code" : "url" - }, - { - "code" : "uuid" - }, - { - "code" : "Address" - }, - { - "code" : "Age" - }, - { - "code" : "Annotation" - }, - { - "code" : "Attachment" - }, - { - "code" : "CodeableConcept" - }, - { - "code" : "CodeableReference" - }, - { - "code" : "Coding" - }, - { - "code" : "ContactPoint" - }, - { - "code" : "Count" - }, - { - "code" : "Distance" - }, - { - "code" : "Duration" - }, - { - "code" : "HumanName" - }, - { - "code" : "Identifier" - }, - { - "code" : "Money" - }, - { - "code" : "Period" - }, - { - "code" : "Quantity" - }, - { - "code" : "Range" - }, - { - "code" : "Ratio" - }, - { - "code" : "Reference" - }, - { - "code" : "SampledData" - }, - { - "code" : "Signature" - }, - { - "code" : "Timing" - }, - { - "code" : "ContactDetail" - }, - { - "code" : "Contributor" - }, - { - "code" : "DataRequirement" - }, - { - "code" : "Expression" - }, - { - "code" : "ParameterDefinition" - }, - { - "code" : "RelatedArtifact" - }, - { - "code" : "TriggerDefinition" - }, - { - "code" : "UsageContext" - }, - { - "code" : "Dosage" - }, - { - "code" : "Meta" - }], - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Extension","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Extension\n \n N\n \n \n Element\n Optional Extensions Element\n
\n + Rule: Must have either extensions or value[x], not both\n
\n
Elements defined in Ancestors: \n id, \n extension\n
\n \".\"\n \".\"\n \".\" \n url\n \n 1..1\n uri\n identifies the meaning of the extension\n
\n
\n \".\"\n \".\"\n \".\" \n value[x]\n \n C\n 0..1\n *\n Value of extension\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"can-bind"}],"url":"http://hl7.org/fhir/StructureDefinition/Extension","version":"5.0.0","name":"Extension","status":"active","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"HL7 FHIR Standard","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]}],"description":"Extension Type: Optional Extension Element - found in all resources.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"purpose":"The ability to add extensions in a structured way is what keeps FHIR resources simple.","fhirVersion":"5.0.0","mapping":[{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"}],"kind":"complex-type","abstract":false,"type":"Extension","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DataType","derivation":"specialization","snapshot":{"element":[{"id":"Extension","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"}],"path":"Extension","short":"Optional Extensions Element","definition":"Optional Extension Element - found in all resources.","min":0,"max":"*","base":{"path":"Extension","min":0,"max":"*"},"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"mapping":[{"identity":"rim","map":"n/a,N/A"}]},{"id":"Extension.id","path":"Extension.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Extension.extension","path":"Extension.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Extension.url","path":"Extension.url","representation":["xmlAttr"],"short":"identifies the meaning of the extension","definition":"Source of the definition for the extension code - a logical name or a URL.","comment":"The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.","min":1,"max":"1","base":{"path":"Extension.url","min":1,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"uri"}],"code":"http://hl7.org/fhirpath/System.String"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Extension.value[x]","path":"Extension.value[x]","short":"Value of extension","definition":"Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).","min":0,"max":"1","base":{"path":"Extension.value[x]","min":0,"max":"1"},"type":[{"code":"base64Binary"},{"code":"boolean"},{"code":"canonical"},{"code":"code"},{"code":"date"},{"code":"dateTime"},{"code":"decimal"},{"code":"id"},{"code":"instant"},{"code":"integer"},{"code":"integer64"},{"code":"markdown"},{"code":"oid"},{"code":"positiveInt"},{"code":"string"},{"code":"time"},{"code":"unsignedInt"},{"code":"uri"},{"code":"url"},{"code":"uuid"},{"code":"Address"},{"code":"Age"},{"code":"Annotation"},{"code":"Attachment"},{"code":"CodeableConcept"},{"code":"CodeableReference"},{"code":"Coding"},{"code":"ContactPoint"},{"code":"Count"},{"code":"Distance"},{"code":"Duration"},{"code":"HumanName"},{"code":"Identifier"},{"code":"Money"},{"code":"Period"},{"code":"Quantity"},{"code":"Range"},{"code":"Ratio"},{"code":"RatioRange"},{"code":"Reference"},{"code":"SampledData"},{"code":"Signature"},{"code":"Timing"},{"code":"ContactDetail"},{"code":"DataRequirement"},{"code":"Expression"},{"code":"ParameterDefinition"},{"code":"RelatedArtifact"},{"code":"TriggerDefinition"},{"code":"UsageContext"},{"code":"Availability"},{"code":"ExtendedContactDetail"},{"code":"Dosage"},{"code":"Meta"}],"condition":["ext-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]}]},"differential":{"element":[{"id":"Extension","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"}],"path":"Extension","short":"Optional Extensions Element","definition":"Optional Extension Element - found in all resources.","min":0,"max":"*","constraint":[{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Extension.url","path":"Extension.url","representation":["xmlAttr"],"short":"identifies the meaning of the extension","definition":"Source of the definition for the extension code - a logical name or a URL.","comment":"The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.","min":1,"max":"1","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"uri"}],"code":"http://hl7.org/fhirpath/System.String"}],"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Extension.value[x]","path":"Extension.value[x]","short":"Value of extension","definition":"Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).","min":0,"max":"1","type":[{"code":"base64Binary"},{"code":"boolean"},{"code":"canonical"},{"code":"code"},{"code":"date"},{"code":"dateTime"},{"code":"decimal"},{"code":"id"},{"code":"instant"},{"code":"integer"},{"code":"integer64"},{"code":"markdown"},{"code":"oid"},{"code":"positiveInt"},{"code":"string"},{"code":"time"},{"code":"unsignedInt"},{"code":"uri"},{"code":"url"},{"code":"uuid"},{"code":"Address"},{"code":"Age"},{"code":"Annotation"},{"code":"Attachment"},{"code":"CodeableConcept"},{"code":"CodeableReference"},{"code":"Coding"},{"code":"ContactPoint"},{"code":"Count"},{"code":"Distance"},{"code":"Duration"},{"code":"HumanName"},{"code":"Identifier"},{"code":"Money"},{"code":"Period"},{"code":"Quantity"},{"code":"Range"},{"code":"Ratio"},{"code":"RatioRange"},{"code":"Reference"},{"code":"SampledData"},{"code":"Signature"},{"code":"Timing"},{"code":"ContactDetail"},{"code":"DataRequirement"},{"code":"Expression"},{"code":"ParameterDefinition"},{"code":"RelatedArtifact"},{"code":"TriggerDefinition"},{"code":"UsageContext"},{"code":"Availability"},{"code":"ExtendedContactDetail"},{"code":"Dosage"},{"code":"Meta"}],"condition":["ext-1"],"mapping":[{"identity":"rim","map":"N/A"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Group.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Group.json index 54acf9492..a33cce729 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Group.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Group.json @@ -1,1712 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "Group", - "meta" : { - "lastUpdated" : "2021-04-14T05:30:20.096+00:00" - }, - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Group TUDomainResourceGroup of multiple entities
+ Rule: Can only have members if group is "actual"
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier Σ0..*IdentifierUnique id
\".\"\".\"\".\" active Σ0..1booleanWhether this group's record is in active use
\".\"\".\"\".\" type Σ1..1codeperson | animal | practitioner | device | medication | substance
GroupType (Required)
\".\"\".\"\".\" actual ΣI1..1booleanDescriptive or actual
\".\"\".\"\".\" code Σ0..1CodeableConceptKind of Group members
GroupKind (Example)
\".\"\".\"\".\" name Σ0..1stringLabel for Group
\".\"\".\"\".\" quantity Σ0..1unsignedIntNumber of members
\".\"\".\"\".\" managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
\".\"\".\"\".\" characteristic 0..*BackboneElementInclude / Exclude group members by Trait
\".\"\".\"\".\"\".\" code 1..1CodeableConceptKind of characteristic
GroupCharacteristicKind (Example)
\".\"\".\"\".\"\".\" value[x] 1..1Value held by characteristic
GroupCharacteristicValue (Example)
\".\"\".\"\".\"\".\"\".\" valueCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\"\".\" valueBooleanboolean
\".\"\".\"\".\"\".\"\".\" valueQuantityQuantity
\".\"\".\"\".\"\".\"\".\" valueRangeRange
\".\"\".\"\".\"\".\"\".\" valueReferenceReference()
\".\"\".\"\".\"\".\" exclude 1..1booleanGroup includes or excludes
\".\"\".\"\".\"\".\" period 0..1PeriodPeriod over which characteristic is tested
\".\"\".\"\".\" member I0..*BackboneElementWho or what is in group
\".\"\".\"\".\"\".\" entity 1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member
\".\"\".\"\".\"\".\" period 0..1PeriodPeriod member belonged to the group
\".\"\".\"\".\"\".\" inactive 0..1booleanIf member is no longer in group

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 0 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", - "valueCode" : "business" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "fhir" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/Group", - "version" : "4.6.0", - "name" : "Group", - "status" : "draft", - "date" : "2021-04-14T05:30:20+00:00", - "publisher" : "Health Level Seven International (FHIR Infrastructure)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }, - { - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm" - }] - }], - "description" : "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "interface", - "uri" : "http://hl7.org/fhir/interface", - "name" : "Interface Pattern" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }], - "kind" : "resource", - "abstract" : false, - "type" : "Group", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "Group", - "path" : "Group", - "short" : "Group of multiple entities", - "definition" : "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.", - "comment" : "If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Group", - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "grp-1", - "severity" : "error", - "human" : "Can only have members if group is \"actual\"", - "expression" : "member.empty() or (actual = true)", - "xpath" : "f:actual/@value=true() or not(exists(f:member))", - "source" : "http://hl7.org/fhir/StructureDefinition/Group" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "rim", - "map" : "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]" - }, - { - "identity" : "interface", - "map" : "Participant" - }, - { - "identity" : "w5", - "map" : "administrative.group" - }] - }, - { - "id" : "Group.id", - "path" : "Group.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Group.meta", - "path" : "Group.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Group.implicitRules", - "path" : "Group.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "Group.language", - "path" : "Group.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "Group.text", - "path" : "Group.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "Group.contained", - "path" : "Group.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.extension", - "path" : "Group.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.modifierExtension", - "path" : "Group.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.identifier", - "path" : "Group.identifier", - "short" : "Unique id", - "definition" : "A unique business identifier for this group.", - "requirements" : "Allows the group to be referenced from external specifications.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Group.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "rim", - "map" : "unique(./id[displayable=\"true\" and scope=\"OBJ\"])" - }, - { - "identity" : "interface", - "map" : "Participant.identifier" - }] - }, - { - "id" : "Group.active", - "path" : "Group.active", - "short" : "Whether this group's record is in active use", - "definition" : "Indicates whether the record for the group is available for use or is merely being retained for historical purposes.", - "requirements" : "Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.active", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "rim", - "map" : "./statusCode" - }, - { - "identity" : "interface", - "map" : "Participant.active" - }] - }, - { - "id" : "Group.type", - "path" : "Group.type", - "short" : "person | animal | practitioner | device | medication | substance", - "definition" : "Identifies the broad classification of the kind of resources the group includes.", - "comment" : "Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).", - "requirements" : "Identifies what type of resources the group is made up of.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.type", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupType" - }], - "strength" : "required", - "description" : "Types of resources that are part of group.", - "valueSet" : "http://hl7.org/fhir/ValueSet/group-type|4.6.0" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\"" - }] - }, - { - "id" : "Group.actual", - "path" : "Group.actual", - "short" : "Descriptive or actual", - "definition" : "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.", - "requirements" : "There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.actual", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "condition" : ["grp-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : "true: ./determinerCode=\"GRP\" false: ./determinerCode=\"GRP_KIND\"" - }] - }, - { - "id" : "Group.code", - "path" : "Group.code", - "short" : "Kind of Group members", - "definition" : "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.", - "comment" : "This would generally be omitted for Person resources.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupKind" - }], - "strength" : "example", - "description" : "Kind of particular resource; e.g. cow, syringe, lake, etc." - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "rim", - "map" : "./code" - }] - }, - { - "id" : "Group.name", - "path" : "Group.name", - "short" : "Label for Group", - "definition" : "A label assigned to the group for human identification and communication.", - "requirements" : "Used to identify the group in human communication.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.name", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "./name[type=\"ST\"]" - }, - { - "identity" : "interface", - "map" : "Participant.name" - }] - }, - { - "id" : "Group.quantity", - "path" : "Group.quantity", - "short" : "Number of members", - "definition" : "A count of the number of resource instances that are part of the group.", - "comment" : "Note that the quantity may be less than the number of members if some of the members are not active.", - "requirements" : "Group size is a common defining characteristic.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.quantity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "unsignedInt" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "./quantity" - }] - }, - { - "id" : "Group.managingEntity", - "path" : "Group.managingEntity", - "short" : "Entity that is the custodian of the Group's definition", - "definition" : "Entity responsible for defining and maintaining Group characteristics and/or registered members.", - "comment" : "This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.managingEntity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Group.characteristic", - "path" : "Group.characteristic", - "short" : "Include / Exclude group members by Trait", - "definition" : "Identifies traits whose presence r absence is shared by members of the group.", - "comment" : "All the identified characteristics must be true for an entity to a member of the group.", - "requirements" : "Needs to be a generic mechanism for identifying what individuals can be part of a group.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Group.characteristic", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]" - }] - }, - { - "id" : "Group.characteristic.id", - "path" : "Group.characteristic.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.characteristic.extension", - "path" : "Group.characteristic.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.characteristic.modifierExtension", - "path" : "Group.characteristic.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.characteristic.code", - "path" : "Group.characteristic.code", - "short" : "Kind of characteristic", - "definition" : "A code that identifies the kind of trait being asserted.", - "requirements" : "Need a formal way of identifying the characteristic being described.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.characteristic.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupCharacteristicKind" - }], - "strength" : "example", - "description" : "List of characteristics used to describe group members; e.g. gender, age, owner, location, etc." - }, - "mapping" : [{ - "identity" : "rim", - "map" : "./code" - }] - }, - { - "id" : "Group.characteristic.value[x]", - "path" : "Group.characteristic.value[x]", - "short" : "Value held by characteristic", - "definition" : "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.", - "comment" : "For Range, it means members of the group have a value that falls somewhere within the specified range.", - "requirements" : "The value of the characteristic is what determines group membership.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.characteristic.value[x]", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }, - { - "code" : "boolean" - }, - { - "code" : "Quantity" - }, - { - "code" : "Range" - }, - { - "code" : "Reference" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupCharacteristicValue" - }], - "strength" : "example", - "description" : "Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc." - }, - "mapping" : [{ - "identity" : "rim", - "map" : "./value" - }] - }, - { - "id" : "Group.characteristic.exclude", - "path" : "Group.characteristic.exclude", - "short" : "Group includes or excludes", - "definition" : "If true, indicates the characteristic is one that is NOT held by members of the group.", - "comment" : "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.", - "requirements" : "Sometimes group membership is determined by characteristics not possessed.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.characteristic.exclude", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./valueNegationInd" - }] - }, - { - "id" : "Group.characteristic.period", - "path" : "Group.characteristic.period", - "short" : "Period over which characteristic is tested", - "definition" : "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.characteristic.period", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Period" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member", - "path" : "Group.member", - "short" : "Who or what is in group", - "definition" : "Identifies the resource instances that are members of the group.", - "requirements" : "Often the only thing of interest about a group is \"who's in it\".", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Group.member", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["grp-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player" - }] - }, - { - "id" : "Group.member.id", - "path" : "Group.member.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.member.extension", - "path" : "Group.member.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.member.modifierExtension", - "path" : "Group.member.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.member.entity", - "path" : "Group.member.entity", - "short" : "Reference to the group member", - "definition" : "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.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.member.entity", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/Medication", - "http://hl7.org/fhir/StructureDefinition/Substance", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member.period", - "path" : "Group.member.period", - "short" : "Period member belonged to the group", - "definition" : "The period that the member was in the group, if known.", - "requirements" : "Need to track who was in a group at a particular time.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.member.period", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Period" - }], - "meaningWhenMissing" : "The member is in the group at this time", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member.inactive", - "path" : "Group.member.inactive", - "short" : "If member is no longer in group", - "definition" : "A flag to indicate that the member is no longer in the group, but previously may have been a member.", - "requirements" : "Sometimes you don't know when someone stopped being in a group, but not when.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.member.inactive", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "Members are considered active unless explicitly specified otherwise", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }] - }, - "differential" : { - "element" : [{ - "id" : "Group", - "path" : "Group", - "short" : "Group of multiple entities", - "definition" : "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.", - "comment" : "If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.", - "min" : 0, - "max" : "*", - "constraint" : [{ - "key" : "grp-1", - "severity" : "error", - "human" : "Can only have members if group is \"actual\"", - "expression" : "member.empty() or (actual = true)", - "xpath" : "f:actual/@value=true() or not(exists(f:member))", - "source" : "http://hl7.org/fhir/StructureDefinition/Group" - }], - "mustSupport" : false, - "isModifier" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]" - }, - { - "identity" : "interface", - "map" : "Participant" - }, - { - "identity" : "w5", - "map" : "administrative.group" - }] - }, - { - "id" : "Group.identifier", - "path" : "Group.identifier", - "short" : "Unique id", - "definition" : "A unique business identifier for this group.", - "requirements" : "Allows the group to be referenced from external specifications.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Identifier" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "rim", - "map" : "unique(./id[displayable=\"true\" and scope=\"OBJ\"])" - }, - { - "identity" : "interface", - "map" : "Participant.identifier" - }] - }, - { - "id" : "Group.active", - "path" : "Group.active", - "short" : "Whether this group's record is in active use", - "definition" : "Indicates whether the record for the group is available for use or is merely being retained for historical purposes.", - "requirements" : "Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element", - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "rim", - "map" : "./statusCode" - }, - { - "identity" : "interface", - "map" : "Participant.active" - }] - }, - { - "id" : "Group.type", - "path" : "Group.type", - "short" : "person | animal | practitioner | device | medication | substance", - "definition" : "Identifies the broad classification of the kind of resources the group includes.", - "comment" : "Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).", - "requirements" : "Identifies what type of resources the group is made up of.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupType" - }], - "strength" : "required", - "description" : "Types of resources that are part of group.", - "valueSet" : "http://hl7.org/fhir/ValueSet/group-type|4.6.0" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\"" - }] - }, - { - "id" : "Group.actual", - "path" : "Group.actual", - "short" : "Descriptive or actual", - "definition" : "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.", - "requirements" : "There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "condition" : ["grp-1"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : "true: ./determinerCode=\"GRP\" false: ./determinerCode=\"GRP_KIND\"" - }] - }, - { - "id" : "Group.code", - "path" : "Group.code", - "short" : "Kind of Group members", - "definition" : "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.", - "comment" : "This would generally be omitted for Person resources.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupKind" - }], - "strength" : "example", - "description" : "Kind of particular resource; e.g. cow, syringe, lake, etc." - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "rim", - "map" : "./code" - }] - }, - { - "id" : "Group.name", - "path" : "Group.name", - "short" : "Label for Group", - "definition" : "A label assigned to the group for human identification and communication.", - "requirements" : "Used to identify the group in human communication.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "./name[type=\"ST\"]" - }, - { - "identity" : "interface", - "map" : "Participant.name" - }] - }, - { - "id" : "Group.quantity", - "path" : "Group.quantity", - "short" : "Number of members", - "definition" : "A count of the number of resource instances that are part of the group.", - "comment" : "Note that the quantity may be less than the number of members if some of the members are not active.", - "requirements" : "Group size is a common defining characteristic.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "unsignedInt" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "./quantity" - }] - }, - { - "id" : "Group.managingEntity", - "path" : "Group.managingEntity", - "short" : "Entity that is the custodian of the Group's definition", - "definition" : "Entity responsible for defining and maintaining Group characteristics and/or registered members.", - "comment" : "This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Group.characteristic", - "path" : "Group.characteristic", - "short" : "Include / Exclude group members by Trait", - "definition" : "Identifies traits whose presence r absence is shared by members of the group.", - "comment" : "All the identified characteristics must be true for an entity to a member of the group.", - "requirements" : "Needs to be a generic mechanism for identifying what individuals can be part of a group.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "BackboneElement" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]" - }] - }, - { - "id" : "Group.characteristic.code", - "path" : "Group.characteristic.code", - "short" : "Kind of characteristic", - "definition" : "A code that identifies the kind of trait being asserted.", - "requirements" : "Need a formal way of identifying the characteristic being described.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupCharacteristicKind" - }], - "strength" : "example", - "description" : "List of characteristics used to describe group members; e.g. gender, age, owner, location, etc." - }, - "mapping" : [{ - "identity" : "rim", - "map" : "./code" - }] - }, - { - "id" : "Group.characteristic.value[x]", - "path" : "Group.characteristic.value[x]", - "short" : "Value held by characteristic", - "definition" : "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.", - "comment" : "For Range, it means members of the group have a value that falls somewhere within the specified range.", - "requirements" : "The value of the characteristic is what determines group membership.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }, - { - "code" : "boolean" - }, - { - "code" : "Quantity" - }, - { - "code" : "Range" - }, - { - "code" : "Reference" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupCharacteristicValue" - }], - "strength" : "example", - "description" : "Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc." - }, - "mapping" : [{ - "identity" : "rim", - "map" : "./value" - }] - }, - { - "id" : "Group.characteristic.exclude", - "path" : "Group.characteristic.exclude", - "short" : "Group includes or excludes", - "definition" : "If true, indicates the characteristic is one that is NOT held by members of the group.", - "comment" : "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.", - "requirements" : "Sometimes group membership is determined by characteristics not possessed.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./valueNegationInd" - }] - }, - { - "id" : "Group.characteristic.period", - "path" : "Group.characteristic.period", - "short" : "Period over which characteristic is tested", - "definition" : "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Period" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member", - "path" : "Group.member", - "short" : "Who or what is in group", - "definition" : "Identifies the resource instances that are members of the group.", - "requirements" : "Often the only thing of interest about a group is \"who's in it\".", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["grp-1"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player" - }] - }, - { - "id" : "Group.member.entity", - "path" : "Group.member.entity", - "short" : "Reference to the group member", - "definition" : "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.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/Medication", - "http://hl7.org/fhir/StructureDefinition/Substance", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member.period", - "path" : "Group.member.period", - "short" : "Period member belonged to the group", - "definition" : "The period that the member was in the group, if known.", - "requirements" : "Need to track who was in a group at a particular time.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Period" - }], - "meaningWhenMissing" : "The member is in the group at this time", - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member.inactive", - "path" : "Group.member.inactive", - "short" : "If member is no longer in group", - "definition" : "A flag to indicate that the member is no longer in the group, but previously may have been a member.", - "requirements" : "Sometimes you don't know when someone stopped being in a group, but not when.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "Members are considered active unless explicitly specified otherwise", - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Group","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Group\n \n \n TU\n \n \n DomainResource\n Group of multiple entities\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n 0..*\n Identifier\n Business Identifier for this Group\n
\n
\n
\n \".\"\n \".\"\n \".\" \n active\n \n \n ?!\n Σ\n 0..1\n boolean\n Whether this group's record is in active use\n
\n
\n \".\"\n \".\"\n \".\" \n type\n \n \n Σ\n 1..1\n code\n person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen\n
Binding: \n Group Type (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n membership\n \n \n Σ\n 1..1\n code\n definitional | enumerated\n
Binding: \n Group Membership Basis (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n code\n \n \n Σ\n 0..1\n CodeableConcept\n Kind of Group members\n
Binding: GroupKind (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n name\n \n \n Σ\n 0..1\n string\n Label for Group\n
\n
\n \".\"\n \".\"\n \".\" \n description\n \n \n 0..1\n markdown\n Natural language description of the group\n
\n
\n \".\"\n \".\"\n \".\" \n quantity\n \n \n Σ\n 0..1\n unsignedInt\n Number of members\n
\n
\n \".\"\n \".\"\n \".\" \n managingEntity\n \n \n Σ\n 0..1\n Reference(\n Organization | \n RelatedPerson | \n Practitioner | \n PractitionerRole)\n Entity that is the custodian of the Group's definition\n
\n
\n \".\"\n \".\"\n \".\" \n characteristic\n \n \n Σ\n 0..*\n BackboneElement\n Include / Exclude group members by Trait\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n code\n \n \n Σ\n 1..1\n CodeableConcept\n Kind of characteristic\n
Binding: GroupCharacteristicKind (\n Example)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n value[x]\n \n \n Σ\n 1..1\n Value held by characteristic\n
Binding: GroupCharacteristicValue (\n Example)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueCodeableConcept\n \n \n \n CodeableConcept\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueBoolean\n \n \n \n boolean\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueQuantity\n \n \n \n Quantity\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueRange\n \n \n \n Range\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" valueReference\n \n \n \n Reference()\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n exclude\n \n \n Σ\n 1..1\n boolean\n Group includes or excludes\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n period\n \n \n 0..1\n Period\n Period over which characteristic is tested\n
\n
\n \".\"\n \".\"\n \".\" \n member\n \n \n 0..*\n BackboneElement\n Who or what is in group\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n entity\n \n \n 1..1\n Reference(\n CareTeam | \n Device | \n Group | \n HealthcareService | \n Location | \n Organization | \n Patient | \n Practitioner | \n PractitionerRole | \n RelatedPerson | \n Specimen)\n Reference to the group member\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n period\n \n \n 0..1\n Period\n Period member belonged to the group\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n inactive\n \n \n 0..1\n boolean\n If member is no longer in group\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Base.Individuals"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":3},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"business"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"url":"http://hl7.org/fhir/StructureDefinition/Group","version":"5.0.0","name":"Group","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (FHIR Infrastructure)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg/index.cfm"}]}],"description":"Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"interface","uri":"http://hl7.org/fhir/interface","name":"Interface Pattern"}],"kind":"resource","abstract":false,"type":"Group","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"Group","path":"Group","short":"Group of multiple entities","definition":"Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.","comment":"If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.","min":0,"max":"*","base":{"path":"Group","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"},{"identity":"w5","map":"administrative.group"},{"identity":"interface","map":"Participant"}]},{"id":"Group.id","path":"Group.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Group.meta","path":"Group.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Group.implicitRules","path":"Group.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Group.language","path":"Group.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Group.text","path":"Group.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Group.contained","path":"Group.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.extension","path":"Group.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.modifierExtension","path":"Group.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.identifier","path":"Group.identifier","short":"Business Identifier for this Group","definition":"Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.","comment":"Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.","requirements":"Allows identification of the group as it is known by various participating systems and in a way that remains consistent across servers.","min":0,"max":"*","base":{"path":"Group.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"rim","map":"unique(./id[displayable=\"true\" and scope=\"OBJ\"])"},{"identity":"interface","map":"Participant.identifier"}]},{"id":"Group.active","path":"Group.active","short":"Whether this group's record is in active use","definition":"Indicates whether the record for the group is available for use or is merely being retained for historical purposes.","requirements":"Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).","min":0,"max":"1","base":{"path":"Group.active","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"./statusCode"},{"identity":"interface","map":"Participant.active"}]},{"id":"Group.type","path":"Group.type","short":"person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen","definition":"Identifies the broad classification of the kind of resources the group includes.","comment":"Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type.","requirements":"Identifies what type of resources the group is made up of.","min":1,"max":"1","base":{"path":"Group.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupType"}],"strength":"required","description":"Types of resources that are part of group.","valueSet":"http://hl7.org/fhir/ValueSet/group-type|5.0.0"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":"person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\""}]},{"id":"Group.membership","path":"Group.membership","short":"definitional | enumerated","definition":"Basis for membership in the Group:\n\n* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.\n* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.","requirements":"There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this element.","min":1,"max":"1","base":{"path":"Group.membership","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"strength":"required","description":"The basis for membership in a group","valueSet":"http://hl7.org/fhir/ValueSet/group-membership-basis|5.0.0"}},{"id":"Group.code","path":"Group.code","short":"Kind of Group members","definition":"Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.","comment":"This would generally be omitted for Person resources.","min":0,"max":"1","base":{"path":"Group.code","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupKind"}],"strength":"example","description":"Kind of particular resource; e.g. cow, syringe, lake, etc."},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"rim","map":"./code"}]},{"id":"Group.name","path":"Group.name","short":"Label for Group","definition":"A label assigned to the group for human identification and communication.","requirements":"Used to identify the group in human communication.","min":0,"max":"1","base":{"path":"Group.name","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./name[type=\"ST\"]"},{"identity":"interface","map":"Participant.name"}]},{"id":"Group.description","path":"Group.description","short":"Natural language description of the group","definition":"Explanation of what the group represents and how it is intended to be used.","min":0,"max":"1","base":{"path":"Group.description","min":0,"max":"1"},"type":[{"code":"markdown"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.quantity","path":"Group.quantity","short":"Number of members","definition":"A count of the number of resource instances that are part of the group.","comment":"Note that the quantity may be less than the number of members if some of the members are not active.","requirements":"Group size is a common defining characteristic.","min":0,"max":"1","base":{"path":"Group.quantity","min":0,"max":"1"},"type":[{"code":"unsignedInt"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./quantity"}]},{"id":"Group.managingEntity","path":"Group.managingEntity","short":"Entity that is the custodian of the Group's definition","definition":"Entity responsible for defining and maintaining Group characteristics and/or registered members.","comment":"This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.","min":0,"max":"1","base":{"path":"Group.managingEntity","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.witness"}]},{"id":"Group.characteristic","path":"Group.characteristic","short":"Include / Exclude group members by Trait","definition":"Identifies traits whose presence r absence is shared by members of the group.","comment":"All the identified characteristics must be true for an entity to a member of the group.","requirements":"Needs to be a generic mechanism for identifying what individuals can be part of a group.","min":0,"max":"*","base":{"path":"Group.characteristic","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"}]},{"id":"Group.characteristic.id","path":"Group.characteristic.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.characteristic.extension","path":"Group.characteristic.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.characteristic.modifierExtension","path":"Group.characteristic.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.characteristic.code","path":"Group.characteristic.code","short":"Kind of characteristic","definition":"A code that identifies the kind of trait being asserted.","requirements":"Need a formal way of identifying the characteristic being described.","min":1,"max":"1","base":{"path":"Group.characteristic.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupCharacteristicKind"}],"strength":"example","description":"List of characteristics used to describe group members; e.g. gender, age, owner, location, etc."},"mapping":[{"identity":"rim","map":"./code"}]},{"id":"Group.characteristic.value[x]","path":"Group.characteristic.value[x]","short":"Value held by characteristic","definition":"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.","comment":"For Range, it means members of the group have a value that falls somewhere within the specified range.","requirements":"The value of the characteristic is what determines group membership.","min":1,"max":"1","base":{"path":"Group.characteristic.value[x]","min":1,"max":"1"},"type":[{"code":"CodeableConcept"},{"code":"boolean"},{"code":"Quantity"},{"code":"Range"},{"code":"Reference"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupCharacteristicValue"}],"strength":"example","description":"Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc."},"mapping":[{"identity":"rim","map":"./value"}]},{"id":"Group.characteristic.exclude","path":"Group.characteristic.exclude","short":"Group includes or excludes","definition":"If true, indicates the characteristic is one that is NOT held by members of the group.","comment":"This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.","requirements":"Sometimes group membership is determined by characteristics not possessed.","min":1,"max":"1","base":{"path":"Group.characteristic.exclude","min":1,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./valueNegationInd"}]},{"id":"Group.characteristic.period","path":"Group.characteristic.period","short":"Period over which characteristic is tested","definition":"The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.","min":0,"max":"1","base":{"path":"Group.characteristic.period","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member","path":"Group.member","short":"Who or what is in group","definition":"Identifies the resource instances that are members of the group.","requirements":"Often the only thing of interest about a group is \"who's in it\".","min":0,"max":"*","base":{"path":"Group.member","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"rim","map":"./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"}]},{"id":"Group.member.id","path":"Group.member.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.member.extension","path":"Group.member.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.member.modifierExtension","path":"Group.member.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.member.entity","path":"Group.member.entity","short":"Reference to the group member","definition":"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.","min":1,"max":"1","base":{"path":"Group.member.entity","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Group","http://hl7.org/fhir/StructureDefinition/HealthcareService","http://hl7.org/fhir/StructureDefinition/Location","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Specimen"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member.period","path":"Group.member.period","short":"Period member belonged to the group","definition":"The period that the member was in the group, if known.","requirements":"Need to track who was in a group at a particular time.","min":0,"max":"1","base":{"path":"Group.member.period","min":0,"max":"1"},"type":[{"code":"Period"}],"meaningWhenMissing":"The member is in the group at this time","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member.inactive","path":"Group.member.inactive","short":"If member is no longer in group","definition":"A flag to indicate that the member is no longer in the group, but previously may have been a member.","requirements":"Sometimes you don't know when someone stopped being in a group, but not when.","min":0,"max":"1","base":{"path":"Group.member.inactive","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"Members are considered active unless explicitly specified otherwise","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false}]},"differential":{"element":[{"id":"Group","path":"Group","short":"Group of multiple entities","definition":"Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.","comment":"If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.","min":0,"max":"*","mustSupport":false,"isModifier":false,"mapping":[{"identity":"w5","map":"administrative.group"},{"identity":"rim","map":"Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"},{"identity":"interface","map":"Participant"}]},{"id":"Group.identifier","path":"Group.identifier","short":"Business Identifier for this Group","definition":"Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.","comment":"Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.","requirements":"Allows identification of the group as it is known by various participating systems and in a way that remains consistent across servers.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"rim","map":"unique(./id[displayable=\"true\" and scope=\"OBJ\"])"},{"identity":"interface","map":"Participant.identifier"}]},{"id":"Group.active","path":"Group.active","short":"Whether this group's record is in active use","definition":"Indicates whether the record for the group is available for use or is merely being retained for historical purposes.","requirements":"Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).","min":0,"max":"1","type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"./statusCode"},{"identity":"interface","map":"Participant.active"}]},{"id":"Group.type","path":"Group.type","short":"person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen","definition":"Identifies the broad classification of the kind of resources the group includes.","comment":"Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type.","requirements":"Identifies what type of resources the group is made up of.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupType"}],"strength":"required","description":"Types of resources that are part of group.","valueSet":"http://hl7.org/fhir/ValueSet/group-type|5.0.0"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":"person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\""}]},{"id":"Group.membership","path":"Group.membership","short":"definitional | enumerated","definition":"Basis for membership in the Group:\n\n* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.\n* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.","requirements":"There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this element.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"strength":"required","description":"The basis for membership in a group","valueSet":"http://hl7.org/fhir/ValueSet/group-membership-basis|5.0.0"}},{"id":"Group.code","path":"Group.code","short":"Kind of Group members","definition":"Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.","comment":"This would generally be omitted for Person resources.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupKind"}],"strength":"example","description":"Kind of particular resource; e.g. cow, syringe, lake, etc."},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"rim","map":"./code"}]},{"id":"Group.name","path":"Group.name","short":"Label for Group","definition":"A label assigned to the group for human identification and communication.","requirements":"Used to identify the group in human communication.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./name[type=\"ST\"]"},{"identity":"interface","map":"Participant.name"}]},{"id":"Group.description","path":"Group.description","short":"Natural language description of the group","definition":"Explanation of what the group represents and how it is intended to be used.","min":0,"max":"1","type":[{"code":"markdown"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.quantity","path":"Group.quantity","short":"Number of members","definition":"A count of the number of resource instances that are part of the group.","comment":"Note that the quantity may be less than the number of members if some of the members are not active.","requirements":"Group size is a common defining characteristic.","min":0,"max":"1","type":[{"code":"unsignedInt"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./quantity"}]},{"id":"Group.managingEntity","path":"Group.managingEntity","short":"Entity that is the custodian of the Group's definition","definition":"Entity responsible for defining and maintaining Group characteristics and/or registered members.","comment":"This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.witness"}]},{"id":"Group.characteristic","path":"Group.characteristic","short":"Include / Exclude group members by Trait","definition":"Identifies traits whose presence r absence is shared by members of the group.","comment":"All the identified characteristics must be true for an entity to a member of the group.","requirements":"Needs to be a generic mechanism for identifying what individuals can be part of a group.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"}]},{"id":"Group.characteristic.code","path":"Group.characteristic.code","short":"Kind of characteristic","definition":"A code that identifies the kind of trait being asserted.","requirements":"Need a formal way of identifying the characteristic being described.","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupCharacteristicKind"}],"strength":"example","description":"List of characteristics used to describe group members; e.g. gender, age, owner, location, etc."},"mapping":[{"identity":"rim","map":"./code"}]},{"id":"Group.characteristic.value[x]","path":"Group.characteristic.value[x]","short":"Value held by characteristic","definition":"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.","comment":"For Range, it means members of the group have a value that falls somewhere within the specified range.","requirements":"The value of the characteristic is what determines group membership.","min":1,"max":"1","type":[{"code":"CodeableConcept"},{"code":"boolean"},{"code":"Quantity"},{"code":"Range"},{"code":"Reference"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupCharacteristicValue"}],"strength":"example","description":"Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc."},"mapping":[{"identity":"rim","map":"./value"}]},{"id":"Group.characteristic.exclude","path":"Group.characteristic.exclude","short":"Group includes or excludes","definition":"If true, indicates the characteristic is one that is NOT held by members of the group.","comment":"This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.","requirements":"Sometimes group membership is determined by characteristics not possessed.","min":1,"max":"1","type":[{"code":"boolean"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./valueNegationInd"}]},{"id":"Group.characteristic.period","path":"Group.characteristic.period","short":"Period over which characteristic is tested","definition":"The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.","min":0,"max":"1","type":[{"code":"Period"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member","path":"Group.member","short":"Who or what is in group","definition":"Identifies the resource instances that are members of the group.","requirements":"Often the only thing of interest about a group is \"who's in it\".","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"rim","map":"./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"}]},{"id":"Group.member.entity","path":"Group.member.entity","short":"Reference to the group member","definition":"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.","min":1,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Group","http://hl7.org/fhir/StructureDefinition/HealthcareService","http://hl7.org/fhir/StructureDefinition/Location","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Specimen"]}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member.period","path":"Group.member.period","short":"Period member belonged to the group","definition":"The period that the member was in the group, if known.","requirements":"Need to track who was in a group at a particular time.","min":0,"max":"1","type":[{"code":"Period"}],"meaningWhenMissing":"The member is in the group at this time","mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member.inactive","path":"Group.member.inactive","short":"If member is no longer in group","definition":"A flag to indicate that the member is no longer in the group, but previously may have been a member.","requirements":"Sometimes you don't know when someone stopped being in a group, but not when.","min":0,"max":"1","type":[{"code":"boolean"}],"meaningWhenMissing":"Members are considered active unless explicitly specified otherwise","mustSupport":false,"isModifier":false,"isSummary":false}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-MedicationRequest.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-MedicationRequest.json index b7397bce2..8e43c5c05 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-MedicationRequest.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-MedicationRequest.json @@ -1,3967 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "MedicationRequest", - "meta" : { - "lastUpdated" : "2021-04-15T12:25:09.461+10:00" - }, - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" MedicationRequest TUDomainResourceOrdering of medication for patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier 0..*IdentifierExternal ids for this request
\".\"\".\"\".\" status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
medicationrequest Status (Required)
\".\"\".\"\".\" statusReason 0..1CodeableConceptReason for current status
medicationRequest Status Reason Codes (Example)
\".\"\".\"\".\" intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
medicationRequest Intent (Required)
\".\"\".\"\".\" category 0..*CodeableConceptGrouping or category of medication request
medicationRequest Administration Location Codes (Example)
\".\"\".\"\".\" priority Σ0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
\".\"\".\"\".\" doNotPerform ?!Σ0..1booleanTrue if patient is to stop taking or not to start taking the medication
\".\"\".\"\".\" reported Σ0..1booleanReported rather than primary record
\".\"\".\"\".\" informationSource 0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)The person or organization who provided the information about this request, if the source is someone other than the requestor
\".\"\".\"\".\" medication Σ1..1CodeableReference(Medication)Medication to be taken
SNOMED CT Medication Codes (Example)
\".\"\".\"\".\" subject Σ1..1Reference(Patient | Group)Who or group medication request is for
\".\"\".\"\".\" encounter 0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
\".\"\".\"\".\" supportingInformation 0..*Reference(Any)Information to support ordering of the medication
\".\"\".\"\".\" authoredOn Σ0..1dateTimeWhen request was initially authored
\".\"\".\"\".\" requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
\".\"\".\"\".\" performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam | HealthcareService)Intended performer of administration
\".\"\".\"\".\" performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Procedure Performer Role Codes (Example)
\".\"\".\"\".\" recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
\".\"\".\"\".\" reason 0..*CodeableReference(Condition | Observation)Reason or indication for ordering or not ordering the medication
Condition/Problem/Diagnosis Codes (Example)
\".\"\".\"\".\" instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition)Instantiates FHIR protocol or definition
\".\"\".\"\".\" instantiatesUri Σ0..*uriInstantiates external protocol or definition
\".\"\".\"\".\" basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
\".\"\".\"\".\" groupIdentifier Σ0..1IdentifierComposite request this is part of
\".\"\".\"\".\" courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
medicationRequest Course of Therapy Codes (Example)
\".\"\".\"\".\" insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
\".\"\".\"\".\" note 0..*AnnotationInformation about the prescription
\".\"\".\"\".\" renderedDosageInstruction 0..1stringFull representation of the dosage instructions
\".\"\".\"\".\" dosageInstruction 0..*DosageHow the medication should be taken
\".\"\".\"\".\" dispenseRequest 0..1BackboneElementMedication supply authorization
\".\"\".\"\".\"\".\" initialFill 0..1BackboneElementFirst fill details
\".\"\".\"\".\"\".\"\".\" quantity 0..1SimpleQuantityFirst fill quantity
\".\"\".\"\".\"\".\"\".\" duration 0..1DurationFirst fill duration
\".\"\".\"\".\"\".\" dispenseInterval 0..1DurationMinimum period of time between dispenses
\".\"\".\"\".\"\".\" validityPeriod 0..1PeriodTime period supply is authorized for
\".\"\".\"\".\"\".\" numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
\".\"\".\"\".\"\".\" quantity 0..1SimpleQuantityAmount of medication to supply per dispense
\".\"\".\"\".\"\".\" expectedSupplyDuration 0..1DurationNumber of days supply per dispense
\".\"\".\"\".\"\".\" dispenser 0..1Reference(Organization)Intended performer of dispense
\".\"\".\"\".\"\".\" dispenserInstruction 0..*AnnotationAdditional information for the dispenser
\".\"\".\"\".\"\".\" doseAdministrationAid 0..1CodeableConceptType of adherence packaging to use for the dispense
Medication Dose Aids (Example)
\".\"\".\"\".\" substitution 0..1BackboneElementAny restrictions on medication substitution
\".\"\".\"\".\"\".\" allowed[x] 1..1Whether substitution is allowed or not
ActSubstanceAdminSubstitutionCode (Example)
\".\"\".\"\".\"\".\"\".\" allowedBooleanboolean
\".\"\".\"\".\"\".\"\".\" allowedCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\" reason 0..1CodeableConceptWhy should (not) substitution be made
SubstanceAdminSubstitutionReason (Example)
\".\"\".\"\".\" priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
\".\"\".\"\".\" detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
\".\"\".\"\".\" eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", - "valueString" : "Clinical.Medications" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 3 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", - "valueCode" : "patient" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "phx" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "version" : "4.6.0", - "name" : "MedicationRequest", - "status" : "draft", - "date" : "2021-04-15T12:25:09+10:00", - "publisher" : "Health Level Seven International (Pharmacy)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }, - { - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/medication/index.cfm" - }] - }], - "description" : "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "workflow", - "uri" : "http://hl7.org/fhir/workflow", - "name" : "Workflow Pattern" - }, - { - "identity" : "script10.6", - "uri" : "http://ncpdp.org/SCRIPT10_6", - "name" : "Mapping to NCPDP SCRIPT 10.6" - }, - { - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }, - { - "identity" : "v2", - "uri" : "http://hl7.org/v2", - "name" : "HL7 v2 Mapping" - }], - "kind" : "resource", - "abstract" : false, - "type" : "MedicationRequest", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "MedicationRequest", - "path" : "MedicationRequest", - "short" : "Ordering of medication for patient or group", - "definition" : "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.", - "alias" : ["Prescription", - "Order"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest", - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "workflow", - "map" : "Request" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx" - }, - { - "identity" : "rim", - "map" : "CombinedMedicationRequest" - }, - { - "identity" : "w5", - "map" : "clinical.medication" - }] - }, - { - "id" : "MedicationRequest.id", - "path" : "MedicationRequest.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "MedicationRequest.meta", - "path" : "MedicationRequest.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "MedicationRequest.implicitRules", - "path" : "MedicationRequest.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "MedicationRequest.language", - "path" : "MedicationRequest.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "MedicationRequest.text", - "path" : "MedicationRequest.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "MedicationRequest.contained", - "path" : "MedicationRequest.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "MedicationRequest.extension", - "path" : "MedicationRequest.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "MedicationRequest.modifierExtension", - "path" : "MedicationRequest.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "MedicationRequest.identifier", - "path" : "MedicationRequest.identifier", - "short" : "External ids for this request", - "definition" : "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.", - "comment" : "This is a business identifier, not a resource identifier.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.identifier" - }, - { - "identity" : "script10.6", - "map" : "Message/Header/PrescriberOrderNumber" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "v2", - "map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number" - }, - { - "identity" : "rim", - "map" : ".id" - }] - }, - { - "id" : "MedicationRequest.status", - "path" : "MedicationRequest.status", - "short" : "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown", - "definition" : "A code specifying the current state of the order. Generally, this will be active or completed state.", - "comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.\n\nClinical decision support systems should take the status into account when determining which medications to include in their algorithms.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "MedicationRequest.status", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestStatus" - }], - "strength" : "required", - "description" : "A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.status" - }, - { - "identity" : "script10.6", - "map" : "no mapping" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "rim", - "map" : ".statusCode" - }] - }, - { - "id" : "MedicationRequest.statusReason", - "path" : "MedicationRequest.statusReason", - "short" : "Reason for current status", - "definition" : "Captures the reason for the current state of the MedicationRequest.", - "comment" : "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.statusReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestStatusReason" - }], - "strength" : "example", - "description" : "Identifies the reasons for a given status.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.statusReason" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" - }] - }, - { - "id" : "MedicationRequest.intent", - "path" : "MedicationRequest.intent", - "short" : "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", - "definition" : "Whether the request is a proposal, plan, or an original order.", - "comment" : "It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.\r\rAn instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.\r\rThis element is labeled as a modifier because the intent alters when and how the resource is actually applicable.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "MedicationRequest.intent", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestIntent" - }], - "strength" : "required", - "description" : "The kind of medication order.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.intent" - }, - { - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)" - }] - }, - { - "id" : "MedicationRequest.category", - "path" : "MedicationRequest.category", - "short" : "Grouping or category of medication request", - "definition" : "Indicates the grouping or category of medication request (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).", - "comment" : "The category can be used to include where the medication is expected to be consumed or other types of requests.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestAdministrationLocation" - }], - "strength" : "example", - "description" : "A coded concept identifying where the medication is to be consumed or administered.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" - }, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Directions\r\ror \r\rMessage/Body/NewRx/MedicationPrescribed/StructuredSIG" - }, - { - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value" - }] - }, - { - "id" : "MedicationRequest.priority", - "path" : "MedicationRequest.priority", - "short" : "routine | urgent | asap | stat", - "definition" : "Indicates how quickly the Medication Request should be addressed with respect to other requests.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.priority", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestPriority" - }], - "strength" : "required", - "description" : "Identifies the level of importance to be assigned to actioning the request.", - "valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.priority" - }, - { - "identity" : "w5", - "map" : "FiveWs.grade" - }, - { - "identity" : "rim", - "map" : ".priorityCode" - }] - }, - { - "id" : "MedicationRequest.doNotPerform", - "path" : "MedicationRequest.doNotPerform", - "short" : "True if patient is to stop taking or not to start taking the medication", - "definition" : "If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.", - "comment" : "If do not perform is not specified, the request is a positive request e.g. \"do perform\".", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.doNotPerform", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc)", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "SubstanceAdministration.actionNegationInd" - }] - }, - { - "id" : "MedicationRequest.reported", - "path" : "MedicationRequest.reported", - "short" : "Reported rather than primary record", - "definition" : "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.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.reported", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : ".participation[typeCode=INF].role" - }] - }, - { - "id" : "MedicationRequest.informationSource", - "path" : "MedicationRequest.informationSource", - "short" : "The person or organization who provided the information about this request, if the source is someone other than the requestor", - "definition" : "The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.informationSource", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".participation[typeCode=INF].role[classCode=PAT, or codes for Practitioner or Related Person or Practitioner Role or Organization" - }] - }, - { - "id" : "MedicationRequest.medication", - "path" : "MedicationRequest.medication", - "short" : "Medication to be taken", - "definition" : "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.", - "comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "MedicationRequest.medication", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationCode" - }], - "strength" : "example", - "description" : "A coded concept identifying substance or product that can be ordered.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.code" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed\r\rMedication.code.coding.code = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCode\r\rMedication.code.coding.system = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCodeQualifier\r\rMedication.code.coding.display = Message/Body/NewRx/MedicationPrescribed/DrugDescription" - }, - { - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "v2", - "map" : "RXE-2-Give Code / RXO-1-Requested Give Code / RXC-2-Component Code" - }, - { - "identity" : "rim", - "map" : "consumable.administrableMedication" - }] - }, - { - "id" : "MedicationRequest.subject", - "path" : "MedicationRequest.subject", - "short" : "Who or group medication request is for", - "definition" : "A link to a resource representing the person or set of individuals to whom the medication will be given.", - "comment" : "The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "MedicationRequest.subject", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.subject" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/Patient\r\r(need detail to link to specific patient … Patient.Identification in SCRIPT)" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3-Patient ID List" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].role" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "MedicationRequest.encounter", - "path" : "MedicationRequest.encounter", - "short" : "Encounter created as part of encounter/admission/stay", - "definition" : "The Encounter during which this [x] was created or to which the creation of this record is tightly associated.", - "comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.\" If there is a need to link to episodes of care they will be handled with an extension.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.encounter", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.context" - }, - { - "identity" : "script10.6", - "map" : "no mapping" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "PV1-19-Visit Number" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]" - }] - }, - { - "id" : "MedicationRequest.supportingInformation", - "path" : "MedicationRequest.supportingInformation", - "short" : "Information to support ordering of the medication", - "definition" : "Include additional information (for example, patient height and weight, a MedicationUsage for the patient) that supports the ordering of the medication.", - "comment" : "This attribute can be used to reference a MedicationUsage about the patients' medication use.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.supportingInformation", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.supportingInfo" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]" - }] - }, - { - "id" : "MedicationRequest.authoredOn", - "path" : "MedicationRequest.authoredOn", - "short" : "When request was initially authored", - "definition" : "The date (and perhaps time) when the prescription was initially written or authored on.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.authoredOn", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.authoredOn" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/WrittenDate" - }, - { - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "v2", - "map" : "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction" - }, - { - "identity" : "rim", - "map" : "author.time" - }] - }, - { - "id" : "MedicationRequest.requester", - "path" : "MedicationRequest.requester", - "short" : "Who/What requested the Request", - "definition" : "The individual, organization, or device that initiated the request and has responsibility for its activation.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.requester", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Device"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.requester" - }, - { - "identity" : "w5", - "map" : "FiveWs.author" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].role" - }] - }, - { - "id" : "MedicationRequest.performer", - "path" : "MedicationRequest.performer", - "short" : "Intended performer of administration", - "definition" : "The specified desired performer of the medication treatment (e.g. the performer of the medication administration).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.performer", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/CareTeam", - "http://hl7.org/fhir/StructureDefinition/HealthcareService"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performer" - }, - { - "identity" : "w5", - "map" : "FiveWs.actor" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" - }] - }, - { - "id" : "MedicationRequest.performerType", - "path" : "MedicationRequest.performerType", - "short" : "Desired kind of performer of the medication administration", - "definition" : "Indicates the type of performer of the administration of the medication.", - "comment" : "If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.performerType", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestPerformerType" - }], - "strength" : "example", - "description" : "Identifies the type of individual that is desired to administer the medication.", - "valueSet" : "http://hl7.org/fhir/ValueSet/performer-role" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performerType" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code" - }] - }, - { - "id" : "MedicationRequest.recorder", - "path" : "MedicationRequest.recorder", - "short" : "Person who entered the request", - "definition" : "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.recorder", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.who" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)" - }] - }, - { - "id" : "MedicationRequest.reason", - "path" : "MedicationRequest.reason", - "short" : "Reason or indication for ordering or not ordering the medication", - "definition" : "The reason or the indication for ordering or not ordering the medication.", - "comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.reason", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition", - "http://hl7.org/fhir/StructureDefinition/Observation"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestReason" - }], - "strength" : "example", - "description" : "A coded concept indicating why the medication was ordered.", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-code" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reasonCode" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value" - }, - { - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "v2", - "map" : "ORC-16-Order Control Code Reason /RXE-27-Give Indication/RXO-20-Indication / RXD-21-Indication / RXG-22-Indication / RXA-19-Indication" - }, - { - "identity" : "rim", - "map" : "reason.observation.reasonCode | reason.observation[code=ASSERTION].value" - }] - }, - { - "id" : "MedicationRequest.instantiatesCanonical", - "path" : "MedicationRequest.instantiatesCanonical", - "short" : "Instantiates FHIR protocol or definition", - "definition" : "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.instantiatesCanonical", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition", - "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiates" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "MedicationRequest.instantiatesUri", - "path" : "MedicationRequest.instantiatesUri", - "short" : "Instantiates external protocol or definition", - "definition" : "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.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.instantiatesUri", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "MedicationRequest.basedOn", - "path" : "MedicationRequest.basedOn", - "short" : "What request fulfills", - "definition" : "A plan or request that is fulfilled in whole or in part by this medication request.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.basedOn", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan", - "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "http://hl7.org/fhir/StructureDefinition/ServiceRequest", - "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.basedOn" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]" - }] - }, - { - "id" : "MedicationRequest.groupIdentifier", - "path" : "MedicationRequest.groupIdentifier", - "short" : "Composite request this is part of", - "definition" : "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.", - "requirements" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.groupIdentifier", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.groupIdentifier" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id" - }] - }, - { - "id" : "MedicationRequest.courseOfTherapyType", - "path" : "MedicationRequest.courseOfTherapyType", - "short" : "Overall pattern of medication administration", - "definition" : "The description of the overall pattern of the administration of the medication to the patient.", - "comment" : "This attribute should not be confused with the protocol of the medication.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.courseOfTherapyType", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestCourseOfTherapy" - }], - "strength" : "example", - "description" : "Identifies the overall pattern of medication administratio.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" - }, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.code where classCode = LIST and moodCode = EVN" - }] - }, - { - "id" : "MedicationRequest.insurance", - "path" : "MedicationRequest.insurance", - "short" : "Associated insurance coverage", - "definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.insurance", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage", - "http://hl7.org/fhir/StructureDefinition/ClaimResponse"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.insurance" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COVBY].target" - }] - }, - { - "id" : "MedicationRequest.note", - "path" : "MedicationRequest.note", - "short" : "Information about the prescription", - "definition" : "Extra information about the prescription that could not be conveyed by the other attributes.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.note", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.note" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Note" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value" - }] - }, - { - "id" : "MedicationRequest.renderedDosageInstruction", - "path" : "MedicationRequest.renderedDosageInstruction", - "short" : "Full representation of the dosage instructions", - "definition" : "The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", - "requirements" : "The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.renderedDosageInstruction", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "SubstanceAdministration.text" - }] - }, - { - "id" : "MedicationRequest.dosageInstruction", - "path" : "MedicationRequest.dosageInstruction", - "short" : "How the medication should be taken", - "definition" : "Indicates how the medication is to be used by the patient.", - "comment" : "There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, \"Ondansetron 8mg orally or IV twice a day as needed for nausea\" or \"Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting\". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. In general, each prescribed drug will be a separate Medication Request. \n\nWhen drug orders are grouped together at the time of order entry, but each of the drugs can be manipulated independently e.g. changing the status of one order to \"completed\" or \"cancelled\", changing another order status to \"on-hold\", the method to \"group\" all of the medication requests together is to use MedicationRequest.groupIdentifier element. All of the orders grouped together in this manner will have the same groupIdentifier, and separately, each order in the group may have a unique identifier. \n\nThere are cases that require grouping of Medication orders together when it is necessary to specify optionality e.g. order two drugs at one time, but stating either of these drugs may be used to treat the patient. The use of a RequestGroup should be used as a parent for the Medication orders that require this type of grouping. An example when it may be necessary to group medication orders together is when you specify timing relationships e.g. order drug \"xyz\" with dose 123, then taper the same drug to a different dose after some interval of time\nprecedence:\ne.g. give drug \"abc\" followed by drug \"def\"\ne.g. give drug 30 minutes before some procedure was performed\nmore generically this supports - hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.\nNote that one should NOT use the List or Composition resource to accomplish the above requirements. You may use List or Composition for other business requirements, but not to address the specific requirements of grouping medication orders.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.dosageInstruction", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Dosage" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.occurrence[x]" - }, - { - "identity" : "rim", - "map" : "see dosageInstruction mapping" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest", - "path" : "MedicationRequest.dispenseRequest", - "short" : "Medication supply authorization", - "definition" : "Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest", - "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() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/ExpirationDate" - }, - { - "identity" : "rim", - "map" : "component.supplyEvent" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.id", - "path" : "MedicationRequest.dispenseRequest.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.extension", - "path" : "MedicationRequest.dispenseRequest.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.modifierExtension", - "path" : "MedicationRequest.dispenseRequest.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill", - "path" : "MedicationRequest.dispenseRequest.initialFill", - "short" : "First fill details", - "definition" : "Indicates the quantity or duration for the first dispense of the medication.", - "comment" : "If populating this element, either the quantity or the duration must be included.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.initialFill", - "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() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "SubstanceAdministration -> ActRelationship[sequenceNumber = '1'] -> Supply" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill.id", - "path" : "MedicationRequest.dispenseRequest.initialFill.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill.extension", - "path" : "MedicationRequest.dispenseRequest.initialFill.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill.modifierExtension", - "path" : "MedicationRequest.dispenseRequest.initialFill.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill.quantity", - "path" : "MedicationRequest.dispenseRequest.initialFill.quantity", - "short" : "First fill quantity", - "definition" : "The amount or quantity to provide as part of the first dispense.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.initialFill.quantity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.quantity[moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill.duration", - "path" : "MedicationRequest.dispenseRequest.initialFill.duration", - "short" : "First fill duration", - "definition" : "The length of time that the first dispense is expected to last.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.initialFill.duration", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Duration" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.effectivetime[moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.dispenseInterval", - "path" : "MedicationRequest.dispenseRequest.dispenseInterval", - "short" : "Minimum period of time between dispenses", - "definition" : "The minimum period of time that must occur between dispenses of the medication.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.dispenseInterval", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Duration" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.effectivetime[moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.validityPeriod", - "path" : "MedicationRequest.dispenseRequest.validityPeriod", - "short" : "Time period supply is authorized for", - "definition" : "This indicates the validity period of a prescription (stale dating the Prescription).", - "comment" : "It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.", - "requirements" : "Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.validityPeriod", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Period" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Refills" - }, - { - "identity" : "rim", - "map" : "effectiveTime" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed", - "path" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed", - "short" : "Number of refills authorized", - "definition" : "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.", - "comment" : "If displaying \"number of authorized fills\", add 1 to this number.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "unsignedInt" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Quantity" - }, - { - "identity" : "v2", - "map" : "RXE-12-Number of Refills" - }, - { - "identity" : "rim", - "map" : "repeatNumber" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.quantity", - "path" : "MedicationRequest.dispenseRequest.quantity", - "short" : "Amount of medication to supply per dispense", - "definition" : "The amount that is to be dispensed for one fill.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.quantity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/DaysSupply" - }, - { - "identity" : "v2", - "map" : "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system" - }, - { - "identity" : "rim", - "map" : "quantity" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.expectedSupplyDuration", - "path" : "MedicationRequest.dispenseRequest.expectedSupplyDuration", - "short" : "Number of days supply per dispense", - "definition" : "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.", - "comment" : "In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.expectedSupplyDuration", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Duration" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Substitutions" - }, - { - "identity" : "rim", - "map" : "expectedUseTime" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.dispenser", - "path" : "MedicationRequest.dispenseRequest.dispenser", - "short" : "Intended performer of dispense", - "definition" : "Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.dispenser", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.who" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=RQO] .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.dispenserInstruction", - "path" : "MedicationRequest.dispenseRequest.dispenserInstruction", - "short" : "Additional information for the dispenser", - "definition" : "Provides additional information to the dispenser, for example, counselling to be provided to the patient.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.dispenseRequest.dispenserInstruction", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.text" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.doseAdministrationAid", - "path" : "MedicationRequest.dispenseRequest.doseAdministrationAid", - "short" : "Type of adherence packaging to use for the dispense", - "definition" : "Provides information about the type of adherence packaging to be supplied for the medication dispense.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.dispenseRequest.doseAdministrationAid", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestDoseAdministrationAid" - }], - "strength" : "example", - "valueSet" : "http://hl7.org/fhir/ValueSet/medication-dose-aid" - }, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.administerableMedication.product.asContent.container.code" - }] - }, - { - "id" : "MedicationRequest.substitution", - "path" : "MedicationRequest.substitution", - "short" : "Any restrictions on medication substitution", - "definition" : "Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.substitution", - "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() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions" - }, - { - "identity" : "rim", - "map" : "subjectOf.substitutionPersmission" - }] - }, - { - "id" : "MedicationRequest.substitution.id", - "path" : "MedicationRequest.substitution.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "MedicationRequest.substitution.extension", - "path" : "MedicationRequest.substitution.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "MedicationRequest.substitution.modifierExtension", - "path" : "MedicationRequest.substitution.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "MedicationRequest.substitution.allowed[x]", - "path" : "MedicationRequest.substitution.allowed[x]", - "short" : "Whether substitution is allowed or not", - "definition" : "True if the prescriber allows a different drug to be dispensed from what was prescribed.", - "comment" : "This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "MedicationRequest.substitution.allowed[x]", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }, - { - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestSubstitution" - }], - "strength" : "example", - "description" : "Identifies the type of substitution allowed.", - "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode" - }, - "mapping" : [{ - "identity" : "script10.6", - "map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions" - }, - { - "identity" : "v2", - "map" : "RXO-9-Allow Substitutions / RXE-9-Substitution Status" - }, - { - "identity" : "rim", - "map" : "code" - }] - }, - { - "id" : "MedicationRequest.substitution.reason", - "path" : "MedicationRequest.substitution.reason", - "short" : "Why should (not) substitution be made", - "definition" : "Indicates the reason for the substitution, or why substitution must or must not be performed.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.substitution.reason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationIntendedSubstitutionReason" - }], - "strength" : "example", - "description" : "SubstanceAdminSubstitutionReason", - "valueSet" : "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason" - }, - "mapping" : [{ - "identity" : "script10.6", - "map" : "not mapped" - }, - { - "identity" : "v2", - "map" : "RXE-9 Substition status" - }, - { - "identity" : "rim", - "map" : "reasonCode" - }] - }, - { - "id" : "MedicationRequest.priorPrescription", - "path" : "MedicationRequest.priorPrescription", - "short" : "An order/prescription that is being replaced", - "definition" : "A link to a resource representing an earlier order related order or prescription.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "MedicationRequest.priorPrescription", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.replaces" - }, - { - "identity" : "script10.6", - "map" : "not mapped" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=?RPLC or ?SUCC]/target[classCode=SBADM,moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.detectedIssue", - "path" : "MedicationRequest.detectedIssue", - "short" : "Clinical Issue with action", - "definition" : "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.", - "comment" : "This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.", - "alias" : ["Contraindication", - "Drug Utilization Review (DUR)", - "Alert"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.detectedIssue", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value" - }] - }, - { - "id" : "MedicationRequest.eventHistory", - "path" : "MedicationRequest.eventHistory", - "short" : "A list of events of interest in the lifecycle", - "definition" : "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.", - "comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).", - "min" : 0, - "max" : "*", - "base" : { - "path" : "MedicationRequest.eventHistory", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.relevantHistory" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "MedicationRequest", - "path" : "MedicationRequest", - "short" : "Ordering of medication for patient or group", - "definition" : "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.", - "alias" : ["Prescription", - "Order"], - "min" : 0, - "max" : "*", - "mustSupport" : false, - "isModifier" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx" - }, - { - "identity" : "rim", - "map" : "CombinedMedicationRequest" - }, - { - "identity" : "w5", - "map" : "clinical.medication" - }] - }, - { - "id" : "MedicationRequest.identifier", - "path" : "MedicationRequest.identifier", - "short" : "External ids for this request", - "definition" : "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.", - "comment" : "This is a business identifier, not a resource identifier.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Identifier" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.identifier" - }, - { - "identity" : "script10.6", - "map" : "Message/Header/PrescriberOrderNumber" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "v2", - "map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number" - }, - { - "identity" : "rim", - "map" : ".id" - }] - }, - { - "id" : "MedicationRequest.status", - "path" : "MedicationRequest.status", - "short" : "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown", - "definition" : "A code specifying the current state of the order. Generally, this will be active or completed state.", - "comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.\n\nClinical decision support systems should take the status into account when determining which medications to include in their algorithms.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestStatus" - }], - "strength" : "required", - "description" : "A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.status" - }, - { - "identity" : "script10.6", - "map" : "no mapping" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "rim", - "map" : ".statusCode" - }] - }, - { - "id" : "MedicationRequest.statusReason", - "path" : "MedicationRequest.statusReason", - "short" : "Reason for current status", - "definition" : "Captures the reason for the current state of the MedicationRequest.", - "comment" : "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestStatusReason" - }], - "strength" : "example", - "description" : "Identifies the reasons for a given status.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.statusReason" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" - }] - }, - { - "id" : "MedicationRequest.intent", - "path" : "MedicationRequest.intent", - "short" : "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", - "definition" : "Whether the request is a proposal, plan, or an original order.", - "comment" : "It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.\r\rAn instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.\r\rThis element is labeled as a modifier because the intent alters when and how the resource is actually applicable.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestIntent" - }], - "strength" : "required", - "description" : "The kind of medication order.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.intent" - }, - { - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)" - }] - }, - { - "id" : "MedicationRequest.category", - "path" : "MedicationRequest.category", - "short" : "Grouping or category of medication request", - "definition" : "Indicates the grouping or category of medication request (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).", - "comment" : "The category can be used to include where the medication is expected to be consumed or other types of requests.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestAdministrationLocation" - }], - "strength" : "example", - "description" : "A coded concept identifying where the medication is to be consumed or administered.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" - }, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Directions\r\ror \r\rMessage/Body/NewRx/MedicationPrescribed/StructuredSIG" - }, - { - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value" - }] - }, - { - "id" : "MedicationRequest.priority", - "path" : "MedicationRequest.priority", - "short" : "routine | urgent | asap | stat", - "definition" : "Indicates how quickly the Medication Request should be addressed with respect to other requests.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestPriority" - }], - "strength" : "required", - "description" : "Identifies the level of importance to be assigned to actioning the request.", - "valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.priority" - }, - { - "identity" : "w5", - "map" : "FiveWs.grade" - }, - { - "identity" : "rim", - "map" : ".priorityCode" - }] - }, - { - "id" : "MedicationRequest.doNotPerform", - "path" : "MedicationRequest.doNotPerform", - "short" : "True if patient is to stop taking or not to start taking the medication", - "definition" : "If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.", - "comment" : "If do not perform is not specified, the request is a positive request e.g. \"do perform\".", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc)", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "SubstanceAdministration.actionNegationInd" - }] - }, - { - "id" : "MedicationRequest.reported", - "path" : "MedicationRequest.reported", - "short" : "Reported rather than primary record", - "definition" : "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.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : ".participation[typeCode=INF].role" - }] - }, - { - "id" : "MedicationRequest.informationSource", - "path" : "MedicationRequest.informationSource", - "short" : "The person or organization who provided the information about this request, if the source is someone other than the requestor", - "definition" : "The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".participation[typeCode=INF].role[classCode=PAT, or codes for Practitioner or Related Person or Practitioner Role or Organization" - }] - }, - { - "id" : "MedicationRequest.medication", - "path" : "MedicationRequest.medication", - "short" : "Medication to be taken", - "definition" : "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.", - "comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationCode" - }], - "strength" : "example", - "description" : "A coded concept identifying substance or product that can be ordered.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.code" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed\r\rMedication.code.coding.code = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCode\r\rMedication.code.coding.system = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCodeQualifier\r\rMedication.code.coding.display = Message/Body/NewRx/MedicationPrescribed/DrugDescription" - }, - { - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "v2", - "map" : "RXE-2-Give Code / RXO-1-Requested Give Code / RXC-2-Component Code" - }, - { - "identity" : "rim", - "map" : "consumable.administrableMedication" - }] - }, - { - "id" : "MedicationRequest.subject", - "path" : "MedicationRequest.subject", - "short" : "Who or group medication request is for", - "definition" : "A link to a resource representing the person or set of individuals to whom the medication will be given.", - "comment" : "The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.subject" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/Patient\r\r(need detail to link to specific patient … Patient.Identification in SCRIPT)" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3-Patient ID List" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].role" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "MedicationRequest.encounter", - "path" : "MedicationRequest.encounter", - "short" : "Encounter created as part of encounter/admission/stay", - "definition" : "The Encounter during which this [x] was created or to which the creation of this record is tightly associated.", - "comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.\" If there is a need to link to episodes of care they will be handled with an extension.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.context" - }, - { - "identity" : "script10.6", - "map" : "no mapping" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "PV1-19-Visit Number" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]" - }] - }, - { - "id" : "MedicationRequest.supportingInformation", - "path" : "MedicationRequest.supportingInformation", - "short" : "Information to support ordering of the medication", - "definition" : "Include additional information (for example, patient height and weight, a MedicationUsage for the patient) that supports the ordering of the medication.", - "comment" : "This attribute can be used to reference a MedicationUsage about the patients' medication use.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.supportingInfo" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]" - }] - }, - { - "id" : "MedicationRequest.authoredOn", - "path" : "MedicationRequest.authoredOn", - "short" : "When request was initially authored", - "definition" : "The date (and perhaps time) when the prescription was initially written or authored on.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "dateTime" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.authoredOn" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/WrittenDate" - }, - { - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "v2", - "map" : "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction" - }, - { - "identity" : "rim", - "map" : "author.time" - }] - }, - { - "id" : "MedicationRequest.requester", - "path" : "MedicationRequest.requester", - "short" : "Who/What requested the Request", - "definition" : "The individual, organization, or device that initiated the request and has responsibility for its activation.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Device"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.requester" - }, - { - "identity" : "w5", - "map" : "FiveWs.author" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=AUT].role" - }] - }, - { - "id" : "MedicationRequest.performer", - "path" : "MedicationRequest.performer", - "short" : "Intended performer of administration", - "definition" : "The specified desired performer of the medication treatment (e.g. the performer of the medication administration).", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/CareTeam", - "http://hl7.org/fhir/StructureDefinition/HealthcareService"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performer" - }, - { - "identity" : "w5", - "map" : "FiveWs.actor" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" - }] - }, - { - "id" : "MedicationRequest.performerType", - "path" : "MedicationRequest.performerType", - "short" : "Desired kind of performer of the medication administration", - "definition" : "Indicates the type of performer of the administration of the medication.", - "comment" : "If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestPerformerType" - }], - "strength" : "example", - "description" : "Identifies the type of individual that is desired to administer the medication.", - "valueSet" : "http://hl7.org/fhir/ValueSet/performer-role" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.performerType" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code" - }] - }, - { - "id" : "MedicationRequest.recorder", - "path" : "MedicationRequest.recorder", - "short" : "Person who entered the request", - "definition" : "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.who" - }, - { - "identity" : "rim", - "map" : ".participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)" - }] - }, - { - "id" : "MedicationRequest.reason", - "path" : "MedicationRequest.reason", - "short" : "Reason or indication for ordering or not ordering the medication", - "definition" : "The reason or the indication for ordering or not ordering the medication.", - "comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "CodeableReference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition", - "http://hl7.org/fhir/StructureDefinition/Observation"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestReason" - }], - "strength" : "example", - "description" : "A coded concept indicating why the medication was ordered.", - "valueSet" : "http://hl7.org/fhir/ValueSet/condition-code" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.reasonCode" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value" - }, - { - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "v2", - "map" : "ORC-16-Order Control Code Reason /RXE-27-Give Indication/RXO-20-Indication / RXD-21-Indication / RXG-22-Indication / RXA-19-Indication" - }, - { - "identity" : "rim", - "map" : "reason.observation.reasonCode | reason.observation[code=ASSERTION].value" - }] - }, - { - "id" : "MedicationRequest.instantiatesCanonical", - "path" : "MedicationRequest.instantiatesCanonical", - "short" : "Instantiates FHIR protocol or definition", - "definition" : "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition", - "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.instantiates" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "MedicationRequest.instantiatesUri", - "path" : "MedicationRequest.instantiatesUri", - "short" : "Instantiates external protocol or definition", - "definition" : "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.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "uri" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "MedicationRequest.basedOn", - "path" : "MedicationRequest.basedOn", - "short" : "What request fulfills", - "definition" : "A plan or request that is fulfilled in whole or in part by this medication request.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan", - "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "http://hl7.org/fhir/StructureDefinition/ServiceRequest", - "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.basedOn" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]" - }] - }, - { - "id" : "MedicationRequest.groupIdentifier", - "path" : "MedicationRequest.groupIdentifier", - "short" : "Composite request this is part of", - "definition" : "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.", - "requirements" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Identifier" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.groupIdentifier" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id" - }] - }, - { - "id" : "MedicationRequest.courseOfTherapyType", - "path" : "MedicationRequest.courseOfTherapyType", - "short" : "Overall pattern of medication administration", - "definition" : "The description of the overall pattern of the administration of the medication to the patient.", - "comment" : "This attribute should not be confused with the protocol of the medication.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestCourseOfTherapy" - }], - "strength" : "example", - "description" : "Identifies the overall pattern of medication administratio.", - "valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" - }, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.code where classCode = LIST and moodCode = EVN" - }] - }, - { - "id" : "MedicationRequest.insurance", - "path" : "MedicationRequest.insurance", - "short" : "Associated insurance coverage", - "definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage", - "http://hl7.org/fhir/StructureDefinition/ClaimResponse"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.insurance" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COVBY].target" - }] - }, - { - "id" : "MedicationRequest.note", - "path" : "MedicationRequest.note", - "short" : "Information about the prescription", - "definition" : "Extra information about the prescription that could not be conveyed by the other attributes.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Annotation" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.note" - }, - { - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Note" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value" - }] - }, - { - "id" : "MedicationRequest.renderedDosageInstruction", - "path" : "MedicationRequest.renderedDosageInstruction", - "short" : "Full representation of the dosage instructions", - "definition" : "The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", - "requirements" : "The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "SubstanceAdministration.text" - }] - }, - { - "id" : "MedicationRequest.dosageInstruction", - "path" : "MedicationRequest.dosageInstruction", - "short" : "How the medication should be taken", - "definition" : "Indicates how the medication is to be used by the patient.", - "comment" : "There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, \"Ondansetron 8mg orally or IV twice a day as needed for nausea\" or \"Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting\". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. In general, each prescribed drug will be a separate Medication Request. \n\nWhen drug orders are grouped together at the time of order entry, but each of the drugs can be manipulated independently e.g. changing the status of one order to \"completed\" or \"cancelled\", changing another order status to \"on-hold\", the method to \"group\" all of the medication requests together is to use MedicationRequest.groupIdentifier element. All of the orders grouped together in this manner will have the same groupIdentifier, and separately, each order in the group may have a unique identifier. \n\nThere are cases that require grouping of Medication orders together when it is necessary to specify optionality e.g. order two drugs at one time, but stating either of these drugs may be used to treat the patient. The use of a RequestGroup should be used as a parent for the Medication orders that require this type of grouping. An example when it may be necessary to group medication orders together is when you specify timing relationships e.g. order drug \"xyz\" with dose 123, then taper the same drug to a different dose after some interval of time\nprecedence:\ne.g. give drug \"abc\" followed by drug \"def\"\ne.g. give drug 30 minutes before some procedure was performed\nmore generically this supports - hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.\nNote that one should NOT use the List or Composition resource to accomplish the above requirements. You may use List or Composition for other business requirements, but not to address the specific requirements of grouping medication orders.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Dosage" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.occurrence[x]" - }, - { - "identity" : "rim", - "map" : "see dosageInstruction mapping" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest", - "path" : "MedicationRequest.dispenseRequest", - "short" : "Medication supply authorization", - "definition" : "Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "BackboneElement" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/ExpirationDate" - }, - { - "identity" : "rim", - "map" : "component.supplyEvent" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill", - "path" : "MedicationRequest.dispenseRequest.initialFill", - "short" : "First fill details", - "definition" : "Indicates the quantity or duration for the first dispense of the medication.", - "comment" : "If populating this element, either the quantity or the duration must be included.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "BackboneElement" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "SubstanceAdministration -> ActRelationship[sequenceNumber = '1'] -> Supply" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill.quantity", - "path" : "MedicationRequest.dispenseRequest.initialFill.quantity", - "short" : "First fill quantity", - "definition" : "The amount or quantity to provide as part of the first dispense.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.quantity[moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.initialFill.duration", - "path" : "MedicationRequest.dispenseRequest.initialFill.duration", - "short" : "First fill duration", - "definition" : "The length of time that the first dispense is expected to last.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Duration" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.effectivetime[moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.dispenseInterval", - "path" : "MedicationRequest.dispenseRequest.dispenseInterval", - "short" : "Minimum period of time between dispenses", - "definition" : "The minimum period of time that must occur between dispenses of the medication.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Duration" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.effectivetime[moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.validityPeriod", - "path" : "MedicationRequest.dispenseRequest.validityPeriod", - "short" : "Time period supply is authorized for", - "definition" : "This indicates the validity period of a prescription (stale dating the Prescription).", - "comment" : "It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.", - "requirements" : "Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Period" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Refills" - }, - { - "identity" : "rim", - "map" : "effectiveTime" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed", - "path" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed", - "short" : "Number of refills authorized", - "definition" : "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.", - "comment" : "If displaying \"number of authorized fills\", add 1 to this number.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "unsignedInt" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Quantity" - }, - { - "identity" : "v2", - "map" : "RXE-12-Number of Refills" - }, - { - "identity" : "rim", - "map" : "repeatNumber" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.quantity", - "path" : "MedicationRequest.dispenseRequest.quantity", - "short" : "Amount of medication to supply per dispense", - "definition" : "The amount that is to be dispensed for one fill.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/DaysSupply" - }, - { - "identity" : "v2", - "map" : "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system" - }, - { - "identity" : "rim", - "map" : "quantity" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.expectedSupplyDuration", - "path" : "MedicationRequest.dispenseRequest.expectedSupplyDuration", - "short" : "Number of days supply per dispense", - "definition" : "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.", - "comment" : "In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Duration" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "Message/Body/NewRx/MedicationPrescribed/Substitutions" - }, - { - "identity" : "rim", - "map" : "expectedUseTime" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.dispenser", - "path" : "MedicationRequest.dispenseRequest.dispenser", - "short" : "Intended performer of dispense", - "definition" : "Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.who" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=RQO] .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.dispenserInstruction", - "path" : "MedicationRequest.dispenseRequest.dispenserInstruction", - "short" : "Additional information for the dispenser", - "definition" : "Provides additional information to the dispenser, for example, counselling to be provided to the patient.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Annotation" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.text" - }] - }, - { - "id" : "MedicationRequest.dispenseRequest.doseAdministrationAid", - "path" : "MedicationRequest.dispenseRequest.doseAdministrationAid", - "short" : "Type of adherence packaging to use for the dispense", - "definition" : "Provides information about the type of adherence packaging to be supplied for the medication dispense.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestDoseAdministrationAid" - }], - "strength" : "example", - "valueSet" : "http://hl7.org/fhir/ValueSet/medication-dose-aid" - }, - "mapping" : [{ - "identity" : "rim", - "map" : "Supply.administerableMedication.product.asContent.container.code" - }] - }, - { - "id" : "MedicationRequest.substitution", - "path" : "MedicationRequest.substitution", - "short" : "Any restrictions on medication substitution", - "definition" : "Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "BackboneElement" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "script10.6", - "map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions" - }, - { - "identity" : "rim", - "map" : "subjectOf.substitutionPersmission" - }] - }, - { - "id" : "MedicationRequest.substitution.allowed[x]", - "path" : "MedicationRequest.substitution.allowed[x]", - "short" : "Whether substitution is allowed or not", - "definition" : "True if the prescriber allows a different drug to be dispensed from what was prescribed.", - "comment" : "This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "boolean" - }, - { - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationRequestSubstitution" - }], - "strength" : "example", - "description" : "Identifies the type of substitution allowed.", - "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode" - }, - "mapping" : [{ - "identity" : "script10.6", - "map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions" - }, - { - "identity" : "v2", - "map" : "RXO-9-Allow Substitutions / RXE-9-Substitution Status" - }, - { - "identity" : "rim", - "map" : "code" - }] - }, - { - "id" : "MedicationRequest.substitution.reason", - "path" : "MedicationRequest.substitution.reason", - "short" : "Why should (not) substitution be made", - "definition" : "Indicates the reason for the substitution, or why substitution must or must not be performed.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MedicationIntendedSubstitutionReason" - }], - "strength" : "example", - "description" : "SubstanceAdminSubstitutionReason", - "valueSet" : "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason" - }, - "mapping" : [{ - "identity" : "script10.6", - "map" : "not mapped" - }, - { - "identity" : "v2", - "map" : "RXE-9 Substition status" - }, - { - "identity" : "rim", - "map" : "reasonCode" - }] - }, - { - "id" : "MedicationRequest.priorPrescription", - "path" : "MedicationRequest.priorPrescription", - "short" : "An order/prescription that is being replaced", - "definition" : "A link to a resource representing an earlier order related order or prescription.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.replaces" - }, - { - "identity" : "script10.6", - "map" : "not mapped" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=?RPLC or ?SUCC]/target[classCode=SBADM,moodCode=RQO]" - }] - }, - { - "id" : "MedicationRequest.detectedIssue", - "path" : "MedicationRequest.detectedIssue", - "short" : "Clinical Issue with action", - "definition" : "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.", - "comment" : "This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.", - "alias" : ["Contraindication", - "Drug Utilization Review (DUR)", - "Alert"], - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value" - }] - }, - { - "id" : "MedicationRequest.eventHistory", - "path" : "MedicationRequest.eventHistory", - "short" : "A list of events of interest in the lifecycle", - "definition" : "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.", - "comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"] - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Request.relevantHistory" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" - }] - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"MedicationRequest","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n MedicationRequest\n \n \n TU\n \n \n DomainResource\n Ordering of medication for patient or group\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n 0..*\n Identifier\n External ids for this request\n
\n
\n
\n \".\"\n \".\"\n \".\" \n basedOn\n \n \n Σ\n 0..*\n Reference(\n CarePlan | \n MedicationRequest | \n ServiceRequest | \n ImmunizationRecommendation)\n A plan or request that is fulfilled in whole or in part by this medication request\n
\n
\n
\n \".\"\n \".\"\n \".\" \n priorPrescription\n \n \n 0..1\n Reference(\n MedicationRequest)\n Reference to an order/prescription that is being replaced by this MedicationRequest\n
\n
\n \".\"\n \".\"\n \".\" \n groupIdentifier\n \n \n Σ\n 0..1\n Identifier\n Composite request this is part of\n
\n
\n \".\"\n \".\"\n \".\" \n status\n \n \n ?!\n Σ\n 1..1\n code\n active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown\n
Binding: \n medicationrequest Status (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n statusReason\n \n \n 0..1\n CodeableConcept\n Reason for current status\n
Binding: \n medicationRequest Status Reason Codes (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n statusChanged\n \n \n 0..1\n dateTime\n When the status was changed\n
\n
\n \".\"\n \".\"\n \".\" \n intent\n \n \n ?!\n Σ\n 1..1\n code\n proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option\n
Binding: \n medicationRequest Intent (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n category\n \n \n 0..*\n CodeableConcept\n Grouping or category of medication request\n
Binding: \n medicationRequest Administration Location Codes (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n priority\n \n \n Σ\n 0..1\n code\n routine | urgent | asap | stat\n
Binding: \n RequestPriority (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n doNotPerform\n \n \n ?!\n Σ\n 0..1\n boolean\n True if patient is to stop taking or not to start taking the medication\n
\n
\n \".\"\n \".\"\n \".\" \n medication\n \n \n Σ\n 1..1\n CodeableReference(\n Medication)\n Medication to be taken\n
Binding: \n SNOMED CT Medication Codes (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n subject\n \n \n Σ\n 1..1\n Reference(\n Patient | \n Group)\n Individual or group for whom the medication has been requested\n
\n
\n \".\"\n \".\"\n \".\" \n informationSource\n \n \n 0..*\n Reference(\n Patient | \n Practitioner | \n PractitionerRole | \n RelatedPerson | \n Organization)\n The person or organization who provided the information about this request, if the source is someone other than the requestor\n
\n
\n
\n \".\"\n \".\"\n \".\" \n encounter\n \n \n 0..1\n Reference(\n Encounter)\n Encounter created as part of encounter/admission/stay\n
\n
\n \".\"\n \".\"\n \".\" \n supportingInformation\n \n \n 0..*\n Reference(\n Any)\n Information to support fulfilling of the medication\n
\n
\n
\n \".\"\n \".\"\n \".\" \n authoredOn\n \n \n Σ\n 0..1\n dateTime\n When request was initially authored\n
\n
\n \".\"\n \".\"\n \".\" \n requester\n \n \n Σ\n 0..1\n Reference(\n Practitioner | \n PractitionerRole | \n Organization | \n Patient | \n RelatedPerson | \n Device)\n Who/What requested the Request\n
\n
\n \".\"\n \".\"\n \".\" \n reported\n \n \n Σ\n 0..1\n boolean\n Reported rather than primary record\n
\n
\n \".\"\n \".\"\n \".\" \n performerType\n \n \n Σ\n 0..1\n CodeableConcept\n Desired kind of performer of the medication administration\n
Binding: \n Medication Intended Performer Role (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\" \n performer\n \n \n 0..*\n Reference(\n Practitioner | \n PractitionerRole | \n Organization | \n Patient | \n DeviceDefinition | \n RelatedPerson | \n CareTeam | \n HealthcareService)\n Intended performer of administration\n
\n
\n
\n \".\"\n \".\"\n \".\" \n device\n \n \n 0..*\n CodeableReference(\n DeviceDefinition)\n Intended type of device for the administration\n
\n
\n
\n \".\"\n \".\"\n \".\" \n recorder\n \n \n 0..1\n Reference(\n Practitioner | \n PractitionerRole)\n Person who entered the request\n
\n
\n \".\"\n \".\"\n \".\" \n reason\n \n \n 0..*\n CodeableReference(\n Condition | \n Observation)\n Reason or indication for ordering or not ordering the medication\n
Binding: \n Condition/Problem/Diagnosis Codes (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n courseOfTherapyType\n \n \n 0..1\n CodeableConcept\n Overall pattern of medication administration\n
Binding: \n medicationRequest Course of Therapy Codes (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\" \n insurance\n \n \n 0..*\n Reference(\n Coverage | \n ClaimResponse)\n Associated insurance coverage\n
\n
\n
\n \".\"\n \".\"\n \".\" \n note\n \n \n 0..*\n Annotation\n Information about the prescription\n
\n
\n
\n \".\"\n \".\"\n \".\" \n renderedDosageInstruction\n \n \n 0..1\n markdown\n Full representation of the dosage instructions\n
\n
\n \".\"\n \".\"\n \".\" \n effectiveDosePeriod\n \n \n 0..1\n Period\n Period over which the medication is to be taken\n
\n
\n \".\"\n \".\"\n \".\" \n dosageInstruction\n \n \n 0..*\n Dosage\n Specific instructions for how the medication should be taken\n
\n
\n
\n \".\"\n \".\"\n \".\" \n dispenseRequest\n \n \n 0..1\n BackboneElement\n Medication supply authorization\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n initialFill\n \n \n 0..1\n BackboneElement\n First fill details\n
\n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n quantity\n \n \n 0..1\n SimpleQuantity\n First fill quantity\n
\n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n duration\n \n \n 0..1\n Duration\n First fill duration\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n dispenseInterval\n \n \n 0..1\n Duration\n Minimum period of time between dispenses\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n validityPeriod\n \n \n 0..1\n Period\n Time period supply is authorized for\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n numberOfRepeatsAllowed\n \n \n 0..1\n unsignedInt\n Number of refills authorized\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n quantity\n \n \n 0..1\n SimpleQuantity\n Amount of medication to supply per dispense\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n expectedSupplyDuration\n \n \n 0..1\n Duration\n Number of days supply per dispense\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n dispenser\n \n \n 0..1\n Reference(\n Organization)\n Intended performer of dispense\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n dispenserInstruction\n \n \n 0..*\n Annotation\n Additional information for the dispenser\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n doseAdministrationAid\n \n \n 0..1\n CodeableConcept\n Type of adherence packaging to use for the dispense\n
Binding: \n Medication Dose Aids (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n substitution\n \n \n 0..1\n BackboneElement\n Any restrictions on medication substitution\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n allowed[x]\n \n \n 1..1\n Whether substitution is allowed or not\n
Binding: \n ActSubstanceAdminSubstitutionCode (\n Preferred)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n allowedBoolean\n \n \n \n boolean\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n allowedCodeableConcept\n \n \n \n CodeableConcept\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n reason\n \n \n 0..1\n CodeableConcept\n Why should (not) substitution be made\n
Binding: \n SubstanceAdminSubstitutionReason (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n eventHistory\n \n \n TU\n 0..*\n Reference(\n Provenance)\n A list of events of interest in the lifecycle\n
\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Clinical.Medications"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":4},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"phx"}],"url":"http://hl7.org/fhir/StructureDefinition/MedicationRequest","version":"5.0.0","name":"MedicationRequest","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (Pharmacy)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/medication/index.cfm"}]}],"description":"An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"workflow","uri":"http://hl7.org/fhir/workflow","name":"Workflow Pattern"},{"identity":"script10.6","uri":"http://ncpdp.org/SCRIPT10_6","name":"Mapping to NCPDP SCRIPT 10.6"},{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"}],"kind":"resource","abstract":false,"type":"MedicationRequest","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"MedicationRequest","path":"MedicationRequest","short":"Ordering of medication for patient or group","definition":"An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.","alias":["Prescription","Order"],"min":0,"max":"*","base":{"path":"MedicationRequest","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,CombinedMedicationRequest"},{"identity":"workflow","map":"Request"},{"identity":"script10.6","map":"Message/Body/NewRx"},{"identity":"w5","map":"clinical.medication"}]},{"id":"MedicationRequest.id","path":"MedicationRequest.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"MedicationRequest.meta","path":"MedicationRequest.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"MedicationRequest.implicitRules","path":"MedicationRequest.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"MedicationRequest.language","path":"MedicationRequest.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"MedicationRequest.text","path":"MedicationRequest.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"MedicationRequest.contained","path":"MedicationRequest.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"MedicationRequest.extension","path":"MedicationRequest.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"MedicationRequest.modifierExtension","path":"MedicationRequest.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"MedicationRequest.identifier","path":"MedicationRequest.identifier","short":"External ids for this request","definition":"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.","comment":"This is a business identifier, not a resource identifier.","min":0,"max":"*","base":{"path":"MedicationRequest.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.identifier"},{"identity":"script10.6","map":"Message/Header/PrescriberOrderNumber"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"ORC-2-Placer Order Number / ORC-3-Filler Order Number"},{"identity":"rim","map":".id"}]},{"id":"MedicationRequest.basedOn","path":"MedicationRequest.basedOn","short":"A plan or request that is fulfilled in whole or in part by this medication request","definition":"A plan or request that is fulfilled in whole or in part by this medication request.","min":0,"max":"*","base":{"path":"MedicationRequest.basedOn","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/ServiceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.basedOn"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]"}]},{"id":"MedicationRequest.priorPrescription","path":"MedicationRequest.priorPrescription","short":"Reference to an order/prescription that is being replaced by this MedicationRequest","definition":"Reference to an order/prescription that is being replaced by this MedicationRequest.","min":0,"max":"1","base":{"path":"MedicationRequest.priorPrescription","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.replaces"},{"identity":"script10.6","map":"not mapped"},{"identity":"rim","map":".outboundRelationship[typeCode=?RPLC or ?SUCC]/target[classCode=SBADM,moodCode=RQO]"}]},{"id":"MedicationRequest.groupIdentifier","path":"MedicationRequest.groupIdentifier","short":"Composite request this is part of","definition":"A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.","requirements":"Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.","min":0,"max":"1","base":{"path":"MedicationRequest.groupIdentifier","min":0,"max":"1"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.groupIdentifier"},{"identity":"rim","map":".outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id"}]},{"id":"MedicationRequest.status","path":"MedicationRequest.status","short":"active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown","definition":"A code specifying the current state of the order. Generally, this will be active or completed state.","comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.\n\nClinical decision support systems should take the status into account when determining which medications to include in their algorithms.","min":1,"max":"1","base":{"path":"MedicationRequest.status","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestStatus"}],"strength":"required","description":"A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-status|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.status"},{"identity":"script10.6","map":"no mapping"},{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":".statusCode"}]},{"id":"MedicationRequest.statusReason","path":"MedicationRequest.statusReason","short":"Reason for current status","definition":"Captures the reason for the current state of the MedicationRequest.","comment":"This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.","min":0,"max":"1","base":{"path":"MedicationRequest.statusReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestStatusReason"}],"strength":"example","description":"Identifies the reasons for a given status.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-status-reason"},"mapping":[{"identity":"workflow","map":"Request.statusReason"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"}]},{"id":"MedicationRequest.statusChanged","path":"MedicationRequest.statusChanged","short":"When the status was changed","definition":"The date (and perhaps time) when the status was changed.","min":0,"max":"1","base":{"path":"MedicationRequest.statusChanged","min":0,"max":"1"},"type":[{"code":"dateTime"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"subjectOf Observation[code = statusChange].value = date"}]},{"id":"MedicationRequest.intent","path":"MedicationRequest.intent","short":"proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option","definition":"Whether the request is a proposal, plan, or an original order.","comment":"It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.\r\rAn instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.\r\rThis element is labeled as a modifier because the intent alters when and how the resource is actually applicable.","min":1,"max":"1","base":{"path":"MedicationRequest.intent","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestIntent"}],"strength":"required","description":"The kind of medication order.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-intent|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.intent"},{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"}]},{"id":"MedicationRequest.category","path":"MedicationRequest.category","short":"Grouping or category of medication request","definition":"An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.","comment":"The category can be used to include where the medication is expected to be consumed or other types of requests. The examplar value set represents where the meds are intended to be administered and is just one example of request categorization.","min":0,"max":"*","base":{"path":"MedicationRequest.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestAdministrationLocation"}],"strength":"example","description":"A coded concept identifying where the medication is to be consumed or administered.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-admin-location"},"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Directions\r\ror \r\rMessage/Body/NewRx/MedicationPrescribed/StructuredSIG"},{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"}]},{"id":"MedicationRequest.priority","path":"MedicationRequest.priority","short":"routine | urgent | asap | stat","definition":"Indicates how quickly the Medication Request should be addressed with respect to other requests.","min":0,"max":"1","base":{"path":"MedicationRequest.priority","min":0,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestPriority"}],"strength":"required","description":"Identifies the level of importance to be assigned to actioning the request.","valueSet":"http://hl7.org/fhir/ValueSet/request-priority|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.priority"},{"identity":"w5","map":"FiveWs.grade"},{"identity":"rim","map":".priorityCode"}]},{"id":"MedicationRequest.doNotPerform","path":"MedicationRequest.doNotPerform","short":"True if patient is to stop taking or not to start taking the medication","definition":"If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.","comment":"If do not perform is not specified, the request is a positive request e.g. \"do perform\".","min":0,"max":"1","base":{"path":"MedicationRequest.doNotPerform","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc.)","isSummary":true,"mapping":[{"identity":"rim","map":"SubstanceAdministration.actionNegationInd"}]},{"id":"MedicationRequest.medication","path":"MedicationRequest.medication","short":"Medication to be taken","definition":"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.","comment":"If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.","min":1,"max":"1","base":{"path":"MedicationRequest.medication","min":1,"max":"1"},"type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Medication"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationCode"}],"strength":"example","description":"A coded concept identifying substance or product that can be ordered.","valueSet":"http://hl7.org/fhir/ValueSet/medication-codes"},"mapping":[{"identity":"workflow","map":"Request.code"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed\r\rMedication.code.coding.code = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCode\r\rMedication.code.coding.system = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCodeQualifier\r\rMedication.code.coding.display = Message/Body/NewRx/MedicationPrescribed/DrugDescription"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"v2","map":"RXE-2-Give Code / RXO-1 Requested Give Code / RXC-2 Component Code"},{"identity":"rim","map":"consumable.administrableMedication"}]},{"id":"MedicationRequest.subject","path":"MedicationRequest.subject","short":"Individual or group for whom the medication has been requested","definition":"The individual or group for whom the medication has been requested.","comment":"The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.","min":1,"max":"1","base":{"path":"MedicationRequest.subject","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.subject"},{"identity":"script10.6","map":"Message/Body/NewRx/Patient\r\r(need detail to link to specific patient … Patient.Identification in SCRIPT)"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3 Patient ID List"},{"identity":"rim","map":".participation[typeCode=AUT].role"}]},{"id":"MedicationRequest.informationSource","path":"MedicationRequest.informationSource","short":"The person or organization who provided the information about this request, if the source is someone other than the requestor","definition":"The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.","min":0,"max":"*","base":{"path":"MedicationRequest.informationSource","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".participation[typeCode=INF].role[classCode=PAT, or codes for Practitioner or Related Person or Practitioner Role or Organization"}]},{"id":"MedicationRequest.encounter","path":"MedicationRequest.encounter","short":"Encounter created as part of encounter/admission/stay","definition":"The Encounter during which this [x] was created or to which the creation of this record is tightly associated.","comment":"This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.\" If there is a need to link to episodes of care they will be handled with an extension.","min":0,"max":"1","base":{"path":"MedicationRequest.encounter","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.encounter"},{"identity":"script10.6","map":"no mapping"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1-19 Visit Number"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"}]},{"id":"MedicationRequest.supportingInformation","path":"MedicationRequest.supportingInformation","short":"Information to support fulfilling of the medication","definition":"Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient).","comment":"This attribute can be used to reference a MedicationStatement about the patients' medication use.","min":0,"max":"*","base":{"path":"MedicationRequest.supportingInformation","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.supportingInfo"},{"identity":"w5","map":"FiveWs.context"},{"identity":"rim","map":".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"}]},{"id":"MedicationRequest.authoredOn","path":"MedicationRequest.authoredOn","short":"When request was initially authored","definition":"The date (and perhaps time) when the prescription was initially written or authored on.","min":0,"max":"1","base":{"path":"MedicationRequest.authoredOn","min":0,"max":"1"},"type":[{"code":"dateTime"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.authoredOn"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/WrittenDate"},{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"RXE-32 Original Order Date/Time / ORC-9-Date Time of Transaction"},{"identity":"rim","map":"author.time"}]},{"id":"MedicationRequest.requester","path":"MedicationRequest.requester","short":"Who/What requested the Request","definition":"The individual, organization, or device that initiated the request and has responsibility for its activation.","min":0,"max":"1","base":{"path":"MedicationRequest.requester","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Device"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.requester"},{"identity":"w5","map":"FiveWs.author"},{"identity":"rim","map":".participation[typeCode=AUT].role"}]},{"id":"MedicationRequest.reported","path":"MedicationRequest.reported","short":"Reported rather than primary record","definition":"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.","comment":"If not populated, then assume that this is the original record and not reported","min":0,"max":"1","base":{"path":"MedicationRequest.reported","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":".participation[typeCode=INF].role"}]},{"id":"MedicationRequest.performerType","path":"MedicationRequest.performerType","short":"Desired kind of performer of the medication administration","definition":"Indicates the type of performer of the administration of the medication.","comment":"If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.","min":0,"max":"1","base":{"path":"MedicationRequest.performerType","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestPerformerType"}],"strength":"extensible","description":"Identifies the type of individual that is desired to administer the medication.","valueSet":"http://hl7.org/fhir/ValueSet/medication-intended-performer-role"},"mapping":[{"identity":"workflow","map":"Request.performerType"},{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"}]},{"id":"MedicationRequest.performer","path":"MedicationRequest.performer","short":"Intended performer of administration","definition":"The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.","min":0,"max":"*","base":{"path":"MedicationRequest.performer","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/DeviceDefinition","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/HealthcareService"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.performer"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}]},{"id":"MedicationRequest.device","path":"MedicationRequest.device","short":"Intended type of device for the administration","definition":"The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).","min":0,"max":"*","base":{"path":"MedicationRequest.device","min":0,"max":"*"},"type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}]},{"id":"MedicationRequest.recorder","path":"MedicationRequest.recorder","short":"Person who entered the request","definition":"The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.","min":0,"max":"1","base":{"path":"MedicationRequest.recorder","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.who"},{"identity":"rim","map":".participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)"}]},{"id":"MedicationRequest.reason","path":"MedicationRequest.reason","short":"Reason or indication for ordering or not ordering the medication","definition":"The reason or the indication for ordering or not ordering the medication.","comment":"This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.","min":0,"max":"*","base":{"path":"MedicationRequest.reason","min":0,"max":"*"},"type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Condition","http://hl7.org/fhir/StructureDefinition/Observation"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestReason"}],"strength":"example","description":"A coded concept indicating why the medication was ordered.","valueSet":"http://hl7.org/fhir/ValueSet/condition-code"},"mapping":[{"identity":"workflow","map":"Request.reason"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value"},{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"ORC-16 Order Control Code Reason /RXE-27 Give Indication/RXO-20-Indication / RXD-21 Indication / RXG-22 Indication / RXA-19 Indication"},{"identity":"rim","map":"reason.observation.reasonCode | reason.observation[code=ASSERTION].value"}]},{"id":"MedicationRequest.courseOfTherapyType","path":"MedicationRequest.courseOfTherapyType","short":"Overall pattern of medication administration","definition":"The description of the overall pattern of the administration of the medication to the patient.","comment":"This attribute should not be confused with the protocol of the medication.","min":0,"max":"1","base":{"path":"MedicationRequest.courseOfTherapyType","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestCourseOfTherapy"}],"strength":"extensible","description":"Identifies the overall pattern of medication administratio.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy"},"mapping":[{"identity":"rim","map":"Act.code where classCode = LIST and moodCode = EVN"}]},{"id":"MedicationRequest.insurance","path":"MedicationRequest.insurance","short":"Associated insurance coverage","definition":"Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.","min":0,"max":"*","base":{"path":"MedicationRequest.insurance","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Coverage","http://hl7.org/fhir/StructureDefinition/ClaimResponse"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.insurance"},{"identity":"rim","map":".outboundRelationship[typeCode=COVBY].target"}]},{"id":"MedicationRequest.note","path":"MedicationRequest.note","short":"Information about the prescription","definition":"Extra information about the prescription that could not be conveyed by the other attributes.","min":0,"max":"*","base":{"path":"MedicationRequest.note","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.note"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Note"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"}]},{"id":"MedicationRequest.renderedDosageInstruction","path":"MedicationRequest.renderedDosageInstruction","short":"Full representation of the dosage instructions","definition":"The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.","requirements":"The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.","min":0,"max":"1","base":{"path":"MedicationRequest.renderedDosageInstruction","min":0,"max":"1"},"type":[{"code":"markdown"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"SubstanceAdministration.text"}]},{"id":"MedicationRequest.effectiveDosePeriod","path":"MedicationRequest.effectiveDosePeriod","short":"Period over which the medication is to be taken","definition":"The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.","min":0,"max":"1","base":{"path":"MedicationRequest.effectiveDosePeriod","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"substanceAdministration.effectiveTime"}]},{"id":"MedicationRequest.dosageInstruction","path":"MedicationRequest.dosageInstruction","short":"Specific instructions for how the medication should be taken","definition":"Specific instructions for how the medication is to be used by the patient.","comment":"There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, \"Ondansetron 8mg orally or IV twice a day as needed for nausea\" or \"Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting\". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. In general, each prescribed drug will be a separate Medication Request. \n\nWhen drug orders are grouped together at the time of order entry, but each of the drugs can be manipulated independently e.g. changing the status of one order to \"completed\" or \"cancelled\", changing another order status to \"on-hold\", the method to \"group\" all of the medication requests together is to use MedicationRequest.groupIdentifier element. All of the orders grouped together in this manner will have the same groupIdentifier, and separately, each order in the group may have a unique identifier. \n\nThere are cases that require grouping of Medication orders together when it is necessary to specify optionality e.g. order two drugs at one time, but stating either of these drugs may be used to treat the patient. The use of a RequestOrchestration should be used as a parent for the Medication orders that require this type of grouping. An example when it may be necessary to group medication orders together is when you specify timing relationships e.g. order drug \"xyz\" with dose 123, then taper the same drug to a different dose after some interval of time\nprecedence:\ne.g. give drug \"abc\" followed by drug \"def\"\ne.g. give drug 30 minutes before some procedure was performed\nmore generically this supports - hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.\nNote that one should NOT use the List or Composition resource to accomplish the above requirements. You may use List or Composition for other business requirements, but not to address the specific requirements of grouping medication orders.","min":0,"max":"*","base":{"path":"MedicationRequest.dosageInstruction","min":0,"max":"*"},"type":[{"code":"Dosage"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"see dosageInstruction mapping"}]},{"id":"MedicationRequest.dispenseRequest","path":"MedicationRequest.dispenseRequest","short":"Medication supply authorization","definition":"Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest","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() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/ExpirationDate"},{"identity":"rim","map":"component.supplyEvent"}]},{"id":"MedicationRequest.dispenseRequest.id","path":"MedicationRequest.dispenseRequest.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"MedicationRequest.dispenseRequest.extension","path":"MedicationRequest.dispenseRequest.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"MedicationRequest.dispenseRequest.modifierExtension","path":"MedicationRequest.dispenseRequest.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"MedicationRequest.dispenseRequest.initialFill","path":"MedicationRequest.dispenseRequest.initialFill","short":"First fill details","definition":"Indicates the quantity or duration for the first dispense of the medication.","comment":"If populating this element, either the quantity or the duration must be included.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.initialFill","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() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"SubstanceAdministration -> ActRelationship[sequenceNumber = '1'] -> Supply"}]},{"id":"MedicationRequest.dispenseRequest.initialFill.id","path":"MedicationRequest.dispenseRequest.initialFill.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"MedicationRequest.dispenseRequest.initialFill.extension","path":"MedicationRequest.dispenseRequest.initialFill.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"MedicationRequest.dispenseRequest.initialFill.modifierExtension","path":"MedicationRequest.dispenseRequest.initialFill.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"MedicationRequest.dispenseRequest.initialFill.quantity","path":"MedicationRequest.dispenseRequest.initialFill.quantity","short":"First fill quantity","definition":"The amount or quantity to provide as part of the first dispense.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.initialFill.quantity","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.quantity[moodCode=RQO]"}]},{"id":"MedicationRequest.dispenseRequest.initialFill.duration","path":"MedicationRequest.dispenseRequest.initialFill.duration","short":"First fill duration","definition":"The length of time that the first dispense is expected to last.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.initialFill.duration","min":0,"max":"1"},"type":[{"code":"Duration"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.effectivetime[moodCode=RQO]"}]},{"id":"MedicationRequest.dispenseRequest.dispenseInterval","path":"MedicationRequest.dispenseRequest.dispenseInterval","short":"Minimum period of time between dispenses","definition":"The minimum period of time that must occur between dispenses of the medication.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.dispenseInterval","min":0,"max":"1"},"type":[{"code":"Duration"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.effectivetime[moodCode=RQO]"}]},{"id":"MedicationRequest.dispenseRequest.validityPeriod","path":"MedicationRequest.dispenseRequest.validityPeriod","short":"Time period supply is authorized for","definition":"This indicates the validity period of a prescription (stale dating the Prescription).","comment":"It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.","requirements":"Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.validityPeriod","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Refills"},{"identity":"rim","map":"effectiveTime"}]},{"id":"MedicationRequest.dispenseRequest.numberOfRepeatsAllowed","path":"MedicationRequest.dispenseRequest.numberOfRepeatsAllowed","short":"Number of refills authorized","definition":"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.","comment":"If displaying \"number of authorized fills\", add 1 to this number.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.numberOfRepeatsAllowed","min":0,"max":"1"},"type":[{"code":"unsignedInt"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Quantity"},{"identity":"v2","map":"RXE-12 Number of Refills"},{"identity":"rim","map":"repeatNumber"}]},{"id":"MedicationRequest.dispenseRequest.quantity","path":"MedicationRequest.dispenseRequest.quantity","short":"Amount of medication to supply per dispense","definition":"The amount that is to be dispensed for one fill.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.quantity","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/DaysSupply"},{"identity":"v2","map":"RXD-4 Actual Dispense Amount / RXD-5.1 Actual Dispense Units.code / RXD-5.3 Actual Dispense Units.name of coding system"},{"identity":"rim","map":"quantity"}]},{"id":"MedicationRequest.dispenseRequest.expectedSupplyDuration","path":"MedicationRequest.dispenseRequest.expectedSupplyDuration","short":"Number of days supply per dispense","definition":"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.","comment":"In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.expectedSupplyDuration","min":0,"max":"1"},"type":[{"code":"Duration"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Substitutions"},{"identity":"rim","map":"expectedUseTime"}]},{"id":"MedicationRequest.dispenseRequest.dispenser","path":"MedicationRequest.dispenseRequest.dispenser","short":"Intended performer of dispense","definition":"Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.dispenser","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.who"},{"identity":"rim","map":".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=RQO] .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}]},{"id":"MedicationRequest.dispenseRequest.dispenserInstruction","path":"MedicationRequest.dispenseRequest.dispenserInstruction","short":"Additional information for the dispenser","definition":"Provides additional information to the dispenser, for example, counselling to be provided to the patient.","min":0,"max":"*","base":{"path":"MedicationRequest.dispenseRequest.dispenserInstruction","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.text"}]},{"id":"MedicationRequest.dispenseRequest.doseAdministrationAid","path":"MedicationRequest.dispenseRequest.doseAdministrationAid","short":"Type of adherence packaging to use for the dispense","definition":"Provides information about the type of adherence packaging to be supplied for the medication dispense.","min":0,"max":"1","base":{"path":"MedicationRequest.dispenseRequest.doseAdministrationAid","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestDoseAdministrationAid"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/medication-dose-aid"},"mapping":[{"identity":"rim","map":"Supply.administerableMedication.product.asContent.container.code"}]},{"id":"MedicationRequest.substitution","path":"MedicationRequest.substitution","short":"Any restrictions on medication substitution","definition":"Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.","min":0,"max":"1","base":{"path":"MedicationRequest.substitution","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() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"},{"identity":"rim","map":"subjectOf.substitutionPersmission"}]},{"id":"MedicationRequest.substitution.id","path":"MedicationRequest.substitution.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"MedicationRequest.substitution.extension","path":"MedicationRequest.substitution.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"MedicationRequest.substitution.modifierExtension","path":"MedicationRequest.substitution.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"MedicationRequest.substitution.allowed[x]","path":"MedicationRequest.substitution.allowed[x]","short":"Whether substitution is allowed or not","definition":"True if the prescriber allows a different drug to be dispensed from what was prescribed.","comment":"This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.","min":1,"max":"1","base":{"path":"MedicationRequest.substitution.allowed[x]","min":1,"max":"1"},"type":[{"code":"boolean"},{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestSubstitution"}],"strength":"preferred","description":"Identifies the type of substitution allowed.","valueSet":"http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode"},"mapping":[{"identity":"script10.6","map":"specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"},{"identity":"v2","map":"RXO-9 Allow Substitutions / RXE-9 Substitution Status"},{"identity":"rim","map":"code"}]},{"id":"MedicationRequest.substitution.reason","path":"MedicationRequest.substitution.reason","short":"Why should (not) substitution be made","definition":"Indicates the reason for the substitution, or why substitution must or must not be performed.","min":0,"max":"1","base":{"path":"MedicationRequest.substitution.reason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationIntendedSubstitutionReason"}],"strength":"example","description":"SubstanceAdminSubstitutionReason","valueSet":"http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason"},"mapping":[{"identity":"script10.6","map":"not mapped"},{"identity":"v2","map":"RXE-9 Substition status"},{"identity":"rim","map":"reasonCode"}]},{"id":"MedicationRequest.eventHistory","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"MedicationRequest.eventHistory","short":"A list of events of interest in the lifecycle","definition":"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.","comment":"This might not include provenances for all versions of the request – only those deemed \"relevant\" or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a \"relevant\" change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).","min":0,"max":"*","base":{"path":"MedicationRequest.eventHistory","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Provenance"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.relevantHistory"},{"identity":"rim","map":".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"}]}]},"differential":{"element":[{"id":"MedicationRequest","path":"MedicationRequest","short":"Ordering of medication for patient or group","definition":"An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.","alias":["Prescription","Order"],"min":0,"max":"*","mustSupport":false,"isModifier":false,"mapping":[{"identity":"workflow","map":"Request"},{"identity":"script10.6","map":"Message/Body/NewRx"},{"identity":"w5","map":"clinical.medication"},{"identity":"rim","map":"CombinedMedicationRequest"}]},{"id":"MedicationRequest.identifier","path":"MedicationRequest.identifier","short":"External ids for this request","definition":"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.","comment":"This is a business identifier, not a resource identifier.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.identifier"},{"identity":"script10.6","map":"Message/Header/PrescriberOrderNumber"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"ORC-2-Placer Order Number / ORC-3-Filler Order Number"},{"identity":"rim","map":".id"}]},{"id":"MedicationRequest.basedOn","path":"MedicationRequest.basedOn","short":"A plan or request that is fulfilled in whole or in part by this medication request","definition":"A plan or request that is fulfilled in whole or in part by this medication request.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/ServiceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.basedOn"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]"}]},{"id":"MedicationRequest.priorPrescription","path":"MedicationRequest.priorPrescription","short":"Reference to an order/prescription that is being replaced by this MedicationRequest","definition":"Reference to an order/prescription that is being replaced by this MedicationRequest.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.replaces"},{"identity":"script10.6","map":"not mapped"},{"identity":"rim","map":".outboundRelationship[typeCode=?RPLC or ?SUCC]/target[classCode=SBADM,moodCode=RQO]"}]},{"id":"MedicationRequest.groupIdentifier","path":"MedicationRequest.groupIdentifier","short":"Composite request this is part of","definition":"A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.","requirements":"Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.","min":0,"max":"1","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.groupIdentifier"},{"identity":"rim","map":".outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id"}]},{"id":"MedicationRequest.status","path":"MedicationRequest.status","short":"active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown","definition":"A code specifying the current state of the order. Generally, this will be active or completed state.","comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.\n\nClinical decision support systems should take the status into account when determining which medications to include in their algorithms.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestStatus"}],"strength":"required","description":"A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-status|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.status"},{"identity":"script10.6","map":"no mapping"},{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":".statusCode"}]},{"id":"MedicationRequest.statusReason","path":"MedicationRequest.statusReason","short":"Reason for current status","definition":"Captures the reason for the current state of the MedicationRequest.","comment":"This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestStatusReason"}],"strength":"example","description":"Identifies the reasons for a given status.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-status-reason"},"mapping":[{"identity":"workflow","map":"Request.statusReason"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"}]},{"id":"MedicationRequest.statusChanged","path":"MedicationRequest.statusChanged","short":"When the status was changed","definition":"The date (and perhaps time) when the status was changed.","min":0,"max":"1","type":[{"code":"dateTime"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"subjectOf Observation[code = statusChange].value = date"}]},{"id":"MedicationRequest.intent","path":"MedicationRequest.intent","short":"proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option","definition":"Whether the request is a proposal, plan, or an original order.","comment":"It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.\r\rAn instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.\r\rThis element is labeled as a modifier because the intent alters when and how the resource is actually applicable.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestIntent"}],"strength":"required","description":"The kind of medication order.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-intent|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.intent"},{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"}]},{"id":"MedicationRequest.category","path":"MedicationRequest.category","short":"Grouping or category of medication request","definition":"An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.","comment":"The category can be used to include where the medication is expected to be consumed or other types of requests. The examplar value set represents where the meds are intended to be administered and is just one example of request categorization.","min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestAdministrationLocation"}],"strength":"example","description":"A coded concept identifying where the medication is to be consumed or administered.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-admin-location"},"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Directions\r\ror \r\rMessage/Body/NewRx/MedicationPrescribed/StructuredSIG"},{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"}]},{"id":"MedicationRequest.priority","path":"MedicationRequest.priority","short":"routine | urgent | asap | stat","definition":"Indicates how quickly the Medication Request should be addressed with respect to other requests.","min":0,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestPriority"}],"strength":"required","description":"Identifies the level of importance to be assigned to actioning the request.","valueSet":"http://hl7.org/fhir/ValueSet/request-priority|5.0.0"},"mapping":[{"identity":"workflow","map":"Request.priority"},{"identity":"w5","map":"FiveWs.grade"},{"identity":"rim","map":".priorityCode"}]},{"id":"MedicationRequest.doNotPerform","path":"MedicationRequest.doNotPerform","short":"True if patient is to stop taking or not to start taking the medication","definition":"If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.","comment":"If do not perform is not specified, the request is a positive request e.g. \"do perform\".","min":0,"max":"1","type":[{"code":"boolean"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc.)","isSummary":true,"mapping":[{"identity":"rim","map":"SubstanceAdministration.actionNegationInd"}]},{"id":"MedicationRequest.medication","path":"MedicationRequest.medication","short":"Medication to be taken","definition":"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.","comment":"If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.","min":1,"max":"1","type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Medication"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationCode"}],"strength":"example","description":"A coded concept identifying substance or product that can be ordered.","valueSet":"http://hl7.org/fhir/ValueSet/medication-codes"},"mapping":[{"identity":"workflow","map":"Request.code"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed\r\rMedication.code.coding.code = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCode\r\rMedication.code.coding.system = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCodeQualifier\r\rMedication.code.coding.display = Message/Body/NewRx/MedicationPrescribed/DrugDescription"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"v2","map":"RXE-2-Give Code / RXO-1 Requested Give Code / RXC-2 Component Code"},{"identity":"rim","map":"consumable.administrableMedication"}]},{"id":"MedicationRequest.subject","path":"MedicationRequest.subject","short":"Individual or group for whom the medication has been requested","definition":"The individual or group for whom the medication has been requested.","comment":"The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.","min":1,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.subject"},{"identity":"script10.6","map":"Message/Body/NewRx/Patient\r\r(need detail to link to specific patient … Patient.Identification in SCRIPT)"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3 Patient ID List"},{"identity":"rim","map":".participation[typeCode=AUT].role"}]},{"id":"MedicationRequest.informationSource","path":"MedicationRequest.informationSource","short":"The person or organization who provided the information about this request, if the source is someone other than the requestor","definition":"The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Organization"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".participation[typeCode=INF].role[classCode=PAT, or codes for Practitioner or Related Person or Practitioner Role or Organization"}]},{"id":"MedicationRequest.encounter","path":"MedicationRequest.encounter","short":"Encounter created as part of encounter/admission/stay","definition":"The Encounter during which this [x] was created or to which the creation of this record is tightly associated.","comment":"This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.\" If there is a need to link to episodes of care they will be handled with an extension.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.encounter"},{"identity":"script10.6","map":"no mapping"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1-19 Visit Number"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"}]},{"id":"MedicationRequest.supportingInformation","path":"MedicationRequest.supportingInformation","short":"Information to support fulfilling of the medication","definition":"Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient).","comment":"This attribute can be used to reference a MedicationStatement about the patients' medication use.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.supportingInfo"},{"identity":"w5","map":"FiveWs.context"},{"identity":"rim","map":".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"}]},{"id":"MedicationRequest.authoredOn","path":"MedicationRequest.authoredOn","short":"When request was initially authored","definition":"The date (and perhaps time) when the prescription was initially written or authored on.","min":0,"max":"1","type":[{"code":"dateTime"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.authoredOn"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/WrittenDate"},{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"RXE-32 Original Order Date/Time / ORC-9-Date Time of Transaction"},{"identity":"rim","map":"author.time"}]},{"id":"MedicationRequest.requester","path":"MedicationRequest.requester","short":"Who/What requested the Request","definition":"The individual, organization, or device that initiated the request and has responsibility for its activation.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Device"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Request.requester"},{"identity":"w5","map":"FiveWs.author"},{"identity":"rim","map":".participation[typeCode=AUT].role"}]},{"id":"MedicationRequest.reported","path":"MedicationRequest.reported","short":"Reported rather than primary record","definition":"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.","comment":"If not populated, then assume that this is the original record and not reported","min":0,"max":"1","type":[{"code":"boolean"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":".participation[typeCode=INF].role"}]},{"id":"MedicationRequest.performerType","path":"MedicationRequest.performerType","short":"Desired kind of performer of the medication administration","definition":"Indicates the type of performer of the administration of the medication.","comment":"If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestPerformerType"}],"strength":"extensible","description":"Identifies the type of individual that is desired to administer the medication.","valueSet":"http://hl7.org/fhir/ValueSet/medication-intended-performer-role"},"mapping":[{"identity":"workflow","map":"Request.performerType"},{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"}]},{"id":"MedicationRequest.performer","path":"MedicationRequest.performer","short":"Intended performer of administration","definition":"The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/DeviceDefinition","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/HealthcareService"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.performer"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}]},{"id":"MedicationRequest.device","path":"MedicationRequest.device","short":"Intended type of device for the administration","definition":"The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).","min":0,"max":"*","type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}]},{"id":"MedicationRequest.recorder","path":"MedicationRequest.recorder","short":"Person who entered the request","definition":"The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.who"},{"identity":"rim","map":".participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)"}]},{"id":"MedicationRequest.reason","path":"MedicationRequest.reason","short":"Reason or indication for ordering or not ordering the medication","definition":"The reason or the indication for ordering or not ordering the medication.","comment":"This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.","min":0,"max":"*","type":[{"code":"CodeableReference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Condition","http://hl7.org/fhir/StructureDefinition/Observation"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestReason"}],"strength":"example","description":"A coded concept indicating why the medication was ordered.","valueSet":"http://hl7.org/fhir/ValueSet/condition-code"},"mapping":[{"identity":"workflow","map":"Request.reason"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value"},{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"ORC-16 Order Control Code Reason /RXE-27 Give Indication/RXO-20-Indication / RXD-21 Indication / RXG-22 Indication / RXA-19 Indication"},{"identity":"rim","map":"reason.observation.reasonCode | reason.observation[code=ASSERTION].value"}]},{"id":"MedicationRequest.courseOfTherapyType","path":"MedicationRequest.courseOfTherapyType","short":"Overall pattern of medication administration","definition":"The description of the overall pattern of the administration of the medication to the patient.","comment":"This attribute should not be confused with the protocol of the medication.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestCourseOfTherapy"}],"strength":"extensible","description":"Identifies the overall pattern of medication administratio.","valueSet":"http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy"},"mapping":[{"identity":"rim","map":"Act.code where classCode = LIST and moodCode = EVN"}]},{"id":"MedicationRequest.insurance","path":"MedicationRequest.insurance","short":"Associated insurance coverage","definition":"Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Coverage","http://hl7.org/fhir/StructureDefinition/ClaimResponse"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.insurance"},{"identity":"rim","map":".outboundRelationship[typeCode=COVBY].target"}]},{"id":"MedicationRequest.note","path":"MedicationRequest.note","short":"Information about the prescription","definition":"Extra information about the prescription that could not be conveyed by the other attributes.","min":0,"max":"*","type":[{"code":"Annotation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.note"},{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Note"},{"identity":"rim","map":".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"}]},{"id":"MedicationRequest.renderedDosageInstruction","path":"MedicationRequest.renderedDosageInstruction","short":"Full representation of the dosage instructions","definition":"The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.","requirements":"The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.","min":0,"max":"1","type":[{"code":"markdown"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"SubstanceAdministration.text"}]},{"id":"MedicationRequest.effectiveDosePeriod","path":"MedicationRequest.effectiveDosePeriod","short":"Period over which the medication is to be taken","definition":"The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.","min":0,"max":"1","type":[{"code":"Period"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"substanceAdministration.effectiveTime"}]},{"id":"MedicationRequest.dosageInstruction","path":"MedicationRequest.dosageInstruction","short":"Specific instructions for how the medication should be taken","definition":"Specific instructions for how the medication is to be used by the patient.","comment":"There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, \"Ondansetron 8mg orally or IV twice a day as needed for nausea\" or \"Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting\". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. In general, each prescribed drug will be a separate Medication Request. \n\nWhen drug orders are grouped together at the time of order entry, but each of the drugs can be manipulated independently e.g. changing the status of one order to \"completed\" or \"cancelled\", changing another order status to \"on-hold\", the method to \"group\" all of the medication requests together is to use MedicationRequest.groupIdentifier element. All of the orders grouped together in this manner will have the same groupIdentifier, and separately, each order in the group may have a unique identifier. \n\nThere are cases that require grouping of Medication orders together when it is necessary to specify optionality e.g. order two drugs at one time, but stating either of these drugs may be used to treat the patient. The use of a RequestOrchestration should be used as a parent for the Medication orders that require this type of grouping. An example when it may be necessary to group medication orders together is when you specify timing relationships e.g. order drug \"xyz\" with dose 123, then taper the same drug to a different dose after some interval of time\nprecedence:\ne.g. give drug \"abc\" followed by drug \"def\"\ne.g. give drug 30 minutes before some procedure was performed\nmore generically this supports - hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.\nNote that one should NOT use the List or Composition resource to accomplish the above requirements. You may use List or Composition for other business requirements, but not to address the specific requirements of grouping medication orders.","min":0,"max":"*","type":[{"code":"Dosage"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"see dosageInstruction mapping"}]},{"id":"MedicationRequest.dispenseRequest","path":"MedicationRequest.dispenseRequest","short":"Medication supply authorization","definition":"Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.","min":0,"max":"1","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/ExpirationDate"},{"identity":"rim","map":"component.supplyEvent"}]},{"id":"MedicationRequest.dispenseRequest.initialFill","path":"MedicationRequest.dispenseRequest.initialFill","short":"First fill details","definition":"Indicates the quantity or duration for the first dispense of the medication.","comment":"If populating this element, either the quantity or the duration must be included.","min":0,"max":"1","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"SubstanceAdministration -> ActRelationship[sequenceNumber = '1'] -> Supply"}]},{"id":"MedicationRequest.dispenseRequest.initialFill.quantity","path":"MedicationRequest.dispenseRequest.initialFill.quantity","short":"First fill quantity","definition":"The amount or quantity to provide as part of the first dispense.","min":0,"max":"1","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.quantity[moodCode=RQO]"}]},{"id":"MedicationRequest.dispenseRequest.initialFill.duration","path":"MedicationRequest.dispenseRequest.initialFill.duration","short":"First fill duration","definition":"The length of time that the first dispense is expected to last.","min":0,"max":"1","type":[{"code":"Duration"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.effectivetime[moodCode=RQO]"}]},{"id":"MedicationRequest.dispenseRequest.dispenseInterval","path":"MedicationRequest.dispenseRequest.dispenseInterval","short":"Minimum period of time between dispenses","definition":"The minimum period of time that must occur between dispenses of the medication.","min":0,"max":"1","type":[{"code":"Duration"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.effectivetime[moodCode=RQO]"}]},{"id":"MedicationRequest.dispenseRequest.validityPeriod","path":"MedicationRequest.dispenseRequest.validityPeriod","short":"Time period supply is authorized for","definition":"This indicates the validity period of a prescription (stale dating the Prescription).","comment":"It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.","requirements":"Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.","min":0,"max":"1","type":[{"code":"Period"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Refills"},{"identity":"rim","map":"effectiveTime"}]},{"id":"MedicationRequest.dispenseRequest.numberOfRepeatsAllowed","path":"MedicationRequest.dispenseRequest.numberOfRepeatsAllowed","short":"Number of refills authorized","definition":"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.","comment":"If displaying \"number of authorized fills\", add 1 to this number.","min":0,"max":"1","type":[{"code":"unsignedInt"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Quantity"},{"identity":"v2","map":"RXE-12 Number of Refills"},{"identity":"rim","map":"repeatNumber"}]},{"id":"MedicationRequest.dispenseRequest.quantity","path":"MedicationRequest.dispenseRequest.quantity","short":"Amount of medication to supply per dispense","definition":"The amount that is to be dispensed for one fill.","min":0,"max":"1","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/DaysSupply"},{"identity":"v2","map":"RXD-4 Actual Dispense Amount / RXD-5.1 Actual Dispense Units.code / RXD-5.3 Actual Dispense Units.name of coding system"},{"identity":"rim","map":"quantity"}]},{"id":"MedicationRequest.dispenseRequest.expectedSupplyDuration","path":"MedicationRequest.dispenseRequest.expectedSupplyDuration","short":"Number of days supply per dispense","definition":"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.","comment":"In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.","min":0,"max":"1","type":[{"code":"Duration"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"Message/Body/NewRx/MedicationPrescribed/Substitutions"},{"identity":"rim","map":"expectedUseTime"}]},{"id":"MedicationRequest.dispenseRequest.dispenser","path":"MedicationRequest.dispenseRequest.dispenser","short":"Intended performer of dispense","definition":"Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.who"},{"identity":"rim","map":".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=RQO] .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"}]},{"id":"MedicationRequest.dispenseRequest.dispenserInstruction","path":"MedicationRequest.dispenseRequest.dispenserInstruction","short":"Additional information for the dispenser","definition":"Provides additional information to the dispenser, for example, counselling to be provided to the patient.","min":0,"max":"*","type":[{"code":"Annotation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Supply.text"}]},{"id":"MedicationRequest.dispenseRequest.doseAdministrationAid","path":"MedicationRequest.dispenseRequest.doseAdministrationAid","short":"Type of adherence packaging to use for the dispense","definition":"Provides information about the type of adherence packaging to be supplied for the medication dispense.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestDoseAdministrationAid"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/medication-dose-aid"},"mapping":[{"identity":"rim","map":"Supply.administerableMedication.product.asContent.container.code"}]},{"id":"MedicationRequest.substitution","path":"MedicationRequest.substitution","short":"Any restrictions on medication substitution","definition":"Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.","min":0,"max":"1","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"script10.6","map":"specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"},{"identity":"rim","map":"subjectOf.substitutionPersmission"}]},{"id":"MedicationRequest.substitution.allowed[x]","path":"MedicationRequest.substitution.allowed[x]","short":"Whether substitution is allowed or not","definition":"True if the prescriber allows a different drug to be dispensed from what was prescribed.","comment":"This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.","min":1,"max":"1","type":[{"code":"boolean"},{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationRequestSubstitution"}],"strength":"preferred","description":"Identifies the type of substitution allowed.","valueSet":"http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode"},"mapping":[{"identity":"script10.6","map":"specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"},{"identity":"v2","map":"RXO-9 Allow Substitutions / RXE-9 Substitution Status"},{"identity":"rim","map":"code"}]},{"id":"MedicationRequest.substitution.reason","path":"MedicationRequest.substitution.reason","short":"Why should (not) substitution be made","definition":"Indicates the reason for the substitution, or why substitution must or must not be performed.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MedicationIntendedSubstitutionReason"}],"strength":"example","description":"SubstanceAdminSubstitutionReason","valueSet":"http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason"},"mapping":[{"identity":"script10.6","map":"not mapped"},{"identity":"v2","map":"RXE-9 Substition status"},{"identity":"rim","map":"reasonCode"}]},{"id":"MedicationRequest.eventHistory","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"MedicationRequest.eventHistory","short":"A list of events of interest in the lifecycle","definition":"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.","comment":"This might not include provenances for all versions of the request – only those deemed \"relevant\" or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a \"relevant\" change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Provenance"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"workflow","map":"Request.relevantHistory"},{"identity":"rim","map":".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Observation.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Observation.json index 2743d3ad8..073fd1c34 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Observation.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Observation.json @@ -1 +1 @@ -{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/orders/index.cfm"}]}],"date":"2021-04-14T05:30:20+00:00","derivation":"specialization","description":"Measurements and simple assertions made about a patient, device or other subject.","differential":{"element":[{"alias":["Vital Signs","Measurement","Results","Tests"],"comment":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.","constraint":[{"expression":"value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()","human":"If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present","key":"obs-7","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Observation","xpath":"not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))"},{"expression":"dataAbsentReason.empty() or value.empty()","human":"dataAbsentReason SHALL only be present if Observation.value[x] is not present","key":"obs-6","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Observation","xpath":"not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))"}],"definition":"Measurements and simple assertions made about a patient, device or other subject.","id":"Observation","isModifier":false,"mapping":[{"identity":"workflow","map":"Event"},{"identity":"sct-concept","map":"< 363787002 |Observable entity|"},{"identity":"v2","map":"OBX"},{"identity":"rim","map":"Observation[classCode=OBS, moodCode=EVN]"},{"identity":"w5","map":"clinical.diagnostics"}],"max":"*","min":0,"mustSupport":false,"path":"Observation","short":"Measurements and simple assertions"},{"definition":"A unique identifier assigned to this observation.","id":"Observation.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."},{"identity":"rim","map":"id"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.identifier","requirements":"Allows observations to be distinguished and referenced.","short":"Business Identifier for observation","type":[{"code":"Identifier"}]},{"comment":"ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.","definition":"The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.","id":"Observation.instantiates[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.instantiates[x]","short":"Instantiates FHIR ObservationDefinition","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]}]},{"alias":["Fulfills"],"definition":"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.","id":"Observation.basedOn","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.basedOn"},{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.basedOn","requirements":"Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","short":"Fulfills plan, proposal or order","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}]},{"alias":["Container"],"comment":"To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.","definition":"A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.","id":"Observation.partOf","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.partOf"},{"identity":"v2","map":"Varies by domain"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.partOf","short":"Part of referenced event","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationAdministration","http://hl7.org/fhir/StructureDefinition/MedicationDispense","http://hl7.org/fhir/StructureDefinition/MedicationUsage","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Immunization","http://hl7.org/fhir/StructureDefinition/ImagingStudy"]}]},{"binding":{"description":"Codes providing the status of an observation.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationStatus"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/observation-status|4.6.0"},"comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","definition":"The status of the result value.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint","valueString":"default: final"}],"id":"Observation.status","isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 445584004 |Report by finality status|"},{"identity":"v2","map":"OBX-11"},{"identity":"rim","map":"status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}],"max":"1","min":1,"mustSupport":false,"path":"Observation.status","requirements":"Need to track the status of individual results. Some results are finalized before the whole report is finalized.","short":"registered | preliminary | final | amended +","type":[{"code":"code"}]},{"binding":{"description":"Codes for high level observation categories.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","definition":"A code that classifies the general type of observation being made.","id":"Observation.category","isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.category","requirements":"Used for filtering what observations are retrieved and displayed.","short":"Classification of type of observation","type":[{"code":"CodeableConcept"}]},{"alias":["Name"],"binding":{"description":"Codes identifying names of simple observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"comment":"*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","definition":"Describes what was observed. Sometimes this is called the observation \"name\".","id":"Observation.code","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"},{"identity":"sct-attr","map":"116680003 |Is a|"}],"max":"1","min":1,"mustSupport":false,"path":"Observation.code","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","short":"Type of observation (code / type)","type":[{"code":"CodeableConcept"}]},{"comment":"One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).","definition":"The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.","id":"Observation.subject","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"participation[typeCode=RTGT]"},{"identity":"w5","map":"FiveWs.subject"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.subject","requirements":"Observations have no value if you don't know who or what they're about.","short":"Who and/or what the observation is about","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Location","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/Medication","http://hl7.org/fhir/StructureDefinition/Substance"]}]},{"comment":"Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [focusCode](extension-observation-focuscode.html).","definition":"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.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"id":"Observation.focus","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"participation[typeCode=SBJ]"},{"identity":"w5","map":"FiveWs.subject"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.focus","short":"What the observation is about, when it is not about the subject of record","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}]},{"alias":["Context"],"comment":"This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).","definition":"The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.","id":"Observation.encounter","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.context"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1"},{"identity":"rim","map":"inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.encounter","requirements":"For some observations it may be important to know the link between an observation and a particular encounter.","short":"Healthcare event during which this observation is made","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}]},{"alias":["Occurrence"],"comment":"At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","definition":"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.","id":"Observation.effective[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"},{"identity":"rim","map":"effectiveTime"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.effective[x]","requirements":"Knowing when an observation was deemed true is important to its relevance as well as determining trends.","short":"Clinically relevant time/time-period for observation","type":[{"code":"dateTime"},{"code":"Period"},{"code":"Timing"},{"code":"instant"}]},{"comment":"For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.","definition":"The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","id":"Observation.issued","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"},{"identity":"rim","map":"participation[typeCode=AUT].time"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.issued","short":"Date/Time this version was made available","type":[{"code":"instant"}]},{"definition":"Who was responsible for asserting the observed value as \"true\".","id":"Observation.performer","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"v2","map":"OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"},{"identity":"rim","map":"participation[typeCode=PRF]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.performer","requirements":"May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","short":"Who is responsible for the observation","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}]},{"comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.","condition":["obs-7"],"definition":"The information determined as a result of making the observation, if the information has a simple value.","id":"Observation.value[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX.2, OBX.5, OBX.6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.value[x]","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","short":"Actual result","type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"}]},{"binding":{"description":"Codes specifying why the result (`Observation.value[x]`) is missing.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"comment":"Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.","condition":["obs-6"],"definition":"Provides a reason why the expected value in the element Observation.value[x] is missing.","id":"Observation.dataAbsentReason","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.dataAbsentReason","requirements":"For many results it is necessary to handle exceptional values in measurements.","short":"Why the result is missing","type":[{"code":"CodeableConcept"}]},{"alias":["Abnormal Flag"],"binding":{"description":"Codes identifying interpretations of observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","definition":"A categorical assessment of an observation value. For example, high, low, normal.","id":"Observation.interpretation","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.interpretation","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","short":"High, low, normal, etc.","type":[{"code":"CodeableConcept"}]},{"comment":"May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.","definition":"Comments about the observation or the results.","id":"Observation.note","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"},{"identity":"rim","map":"subjectOf.observationEvent[code=\"annotation\"].value"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.note","requirements":"Need to be able to provide free text additional information.","short":"Comments about the observation","type":[{"code":"Annotation"}]},{"binding":{"description":"SNOMED CT Body site concepts","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"comment":"Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).","definition":"Indicates the site on the subject's body where the observation was made (i.e. the target site).","id":"Observation.bodySite","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123037004 |Body structure|"},{"identity":"v2","map":"OBX-20"},{"identity":"rim","map":"targetSiteCode"},{"identity":"sct-attr","map":"718497002 |Inherent location|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.bodySite","short":"Observed body part","type":[{"code":"CodeableConcept"}]},{"binding":{"description":"Methods for simple observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationMethod"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/observation-methods"},"comment":"Only used if not implicit in code for Observation.code.","definition":"Indicates the mechanism used to perform the observation.","id":"Observation.method","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-17"},{"identity":"rim","map":"methodCode"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.method","requirements":"In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","short":"How it was done","type":[{"code":"CodeableConcept"}]},{"comment":"Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).","definition":"The specimen that was used when this observation was made.","id":"Observation.specimen","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123038009 |Specimen|"},{"identity":"v2","map":"SPM segment"},{"identity":"rim","map":"participation[typeCode=SPC].specimen"},{"identity":"sct-attr","map":"704319004 |Inherent in|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.specimen","short":"Specimen used for this observation","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Specimen"]}]},{"comment":"Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.","definition":"The device used to generate the observation data.","id":"Observation.device","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 49062001 |Device|"},{"identity":"v2","map":"OBX-17 / PRT -10"},{"identity":"rim","map":"participation[typeCode=DEV]"},{"identity":"sct-attr","map":"424226004 |Using device|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.device","short":"(Measurement) Device","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}]},{"comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","constraint":[{"expression":"low.exists() or high.exists() or text.exists()","human":"Must have at least a low or a high or text","key":"obs-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Observation","xpath":"(exists(f:low) or exists(f:high)or exists(f:text))"}],"definition":"Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.","id":"Observation.referenceRange","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX.7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.referenceRange","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","short":"Provides guide for interpretation","type":[{"code":"BackboneElement"}]},{"condition":["obs-3"],"definition":"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).","id":"Observation.referenceRange.low","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.low"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.low","short":"Low Range, if relevant","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}]},{"condition":["obs-3"],"definition":"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).","id":"Observation.referenceRange.high","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.high"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.high","short":"High Range, if relevant","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}]},{"binding":{"description":"Code for the meaning of a reference range.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeMeaning"}],"strength":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-meaning"},"comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.","definition":"Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","id":"Observation.referenceRange.type","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.type","requirements":"Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.","short":"Reference range qualifier","type":[{"code":"CodeableConcept"}]},{"binding":{"description":"Codes identifying the population the reference range applies to.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeType"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-appliesto"},"comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.","definition":"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.","id":"Observation.referenceRange.appliesTo","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.referenceRange.appliesTo","requirements":"Need to be able to identify the target population for proper interpretation.","short":"Reference range population","type":[{"code":"CodeableConcept"}]},{"definition":"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.","id":"Observation.referenceRange.age","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.age","requirements":"Some analytes vary greatly over age.","short":"Applicable age range, if relevant","type":[{"code":"Range"}]},{"definition":"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\".","id":"Observation.referenceRange.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:ST"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.text","short":"Text based reference range in an observation","type":[{"code":"string"}]},{"comment":"When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.","definition":"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.","id":"Observation.hasMember","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":"outBoundRelationship"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.hasMember","short":"Related resource that belongs to the Observation group","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}]},{"comment":"All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.","definition":"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.","id":"Observation.derivedFrom","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":".targetObservation"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.derivedFrom","short":"Related measurements the observation is made from","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}]},{"comment":"For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.","definition":"Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.","id":"Observation.component","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"containment by OBX-4?"},{"identity":"rim","map":"outBoundRelationship[typeCode=COMP]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.component","requirements":"Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.","short":"Component results","type":[{"code":"BackboneElement"}]},{"binding":{"description":"Codes identifying names of simple observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"comment":"*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","definition":"Describes what was observed. Sometimes this is called the observation \"code\".","id":"Observation.component.code","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"}],"max":"1","min":1,"mustSupport":false,"path":"Observation.component.code","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","short":"Type of component observation (code / type)","type":[{"code":"CodeableConcept"}]},{"comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.","definition":"The information determined as a result of making the observation, if the information has a simple value.","id":"Observation.component.value[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX.2, OBX.5, OBX.6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.component.value[x]","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","short":"Actual component result","type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"}]},{"binding":{"description":"Codes specifying why the result (`Observation.value[x]`) is missing.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"comment":"\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.","condition":["obs-6"],"definition":"Provides a reason why the expected value in the element Observation.component.value[x] is missing.","id":"Observation.component.dataAbsentReason","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.component.dataAbsentReason","requirements":"For many results it is necessary to handle exceptional values in measurements.","short":"Why the component result is missing","type":[{"code":"CodeableConcept"}]},{"alias":["Abnormal Flag"],"binding":{"description":"Codes identifying interpretations of observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","definition":"A categorical assessment of an observation value. For example, high, low, normal.","id":"Observation.component.interpretation","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.component.interpretation","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","short":"High, low, normal, etc.","type":[{"code":"CodeableConcept"}]},{"comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","contentReference":"#Observation.referenceRange","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range.","id":"Observation.component.referenceRange","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX.7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.component.referenceRange","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","short":"Provides guide for interpretation of component result"}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"oo"}],"fhirVersion":"4.6.0","id":"Observation","kind":"resource","mapping":[{"identity":"workflow","name":"Workflow Pattern","uri":"http://hl7.org/fhir/workflow"},{"identity":"sct-concept","name":"SNOMED CT Concept Domain Binding","uri":"http://snomed.info/conceptdomain"},{"identity":"v2","name":"HL7 v2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"w5","name":"FiveWs Pattern Mapping","uri":"http://hl7.org/fhir/fivews"},{"identity":"sct-attr","name":"SNOMED CT Attribute Binding","uri":"http://snomed.org/attributebinding"}],"meta":{"lastUpdated":"2021-04-14T05:30:20.096+00:00"},"name":"Observation","publisher":"Health Level Seven International (Orders and Observations)","purpose":"Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.","resourceType":"StructureDefinition","snapshot":{"element":[{"alias":["Vital Signs","Measurement","Results","Tests"],"base":{"max":"*","min":0,"path":"Observation"},"comment":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.","constraint":[{"expression":"contained.contained.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","key":"dom-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(parent::f:contained and f:contained)"},{"expression":"contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","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","key":"dom-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"},{"expression":"contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated","key":"dom-4","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"},{"expression":"contained.meta.security.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a security label","key":"dom-5","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:security))"},{"expression":"text.`div`.exists()","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"human":"A resource should have narrative for robust management","key":"dom-6","severity":"warning","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"exists(f:text/h:div)"},{"expression":"dataAbsentReason.empty() or value.empty()","human":"dataAbsentReason SHALL only be present if Observation.value[x] is not present","key":"obs-6","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Observation","xpath":"not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))"},{"expression":"value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()","human":"If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present","key":"obs-7","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Observation","xpath":"not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))"}],"definition":"Measurements and simple assertions made about a patient, device or other subject.","id":"Observation","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act"},{"identity":"workflow","map":"Event"},{"identity":"sct-concept","map":"< 363787002 |Observable entity|"},{"identity":"v2","map":"OBX"},{"identity":"rim","map":"Observation[classCode=OBS, moodCode=EVN]"},{"identity":"w5","map":"clinical.diagnostics"}],"max":"*","min":0,"mustSupport":false,"path":"Observation","short":"Measurements and simple assertions"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"Typically, the resource has an id except for cases like the create operation, conditional updates.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Observation.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Observation.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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.","id":"Observation.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Observation.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","id":"Observation.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Observation.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The base language in which the resource is written.","id":"Observation.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"Observation.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"Contained resources do not have a 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 information is added later.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Observation.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.","definition":"These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.","id":"Observation.contained","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"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.","id":"Observation.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Observation.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"base":{"max":"*","min":0,"path":"Observation.identifier"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A unique identifier assigned to this observation.","id":"Observation.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."},{"identity":"rim","map":"id"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.identifier","requirements":"Allows observations to be distinguished and referenced.","short":"Business Identifier for observation","type":[{"code":"Identifier"}]},{"base":{"max":"1","min":0,"path":"Observation.instantiates[x]"},"comment":"ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.","id":"Observation.instantiates[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.instantiates[x]","short":"Instantiates FHIR ObservationDefinition","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]}]},{"alias":["Fulfills"],"base":{"max":"*","min":0,"path":"Observation.basedOn"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Observation.basedOn","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.basedOn"},{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.basedOn","requirements":"Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","short":"Fulfills plan, proposal or order","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}]},{"alias":["Container"],"base":{"max":"*","min":0,"path":"Observation.partOf"},"comment":"To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.","id":"Observation.partOf","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.partOf"},{"identity":"v2","map":"Varies by domain"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.partOf","short":"Part of referenced event","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationAdministration","http://hl7.org/fhir/StructureDefinition/MedicationDispense","http://hl7.org/fhir/StructureDefinition/MedicationUsage","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Immunization","http://hl7.org/fhir/StructureDefinition/ImagingStudy"]}]},{"base":{"max":"1","min":1,"path":"Observation.status"},"binding":{"description":"Codes providing the status of an observation.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationStatus"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/observation-status|4.6.0"},"comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The status of the result value.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint","valueString":"default: final"}],"id":"Observation.status","isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 445584004 |Report by finality status|"},{"identity":"v2","map":"OBX-11"},{"identity":"rim","map":"status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}],"max":"1","min":1,"mustSupport":false,"path":"Observation.status","requirements":"Need to track the status of individual results. Some results are finalized before the whole report is finalized.","short":"registered | preliminary | final | amended +","type":[{"code":"code"}]},{"base":{"max":"*","min":0,"path":"Observation.category"},"binding":{"description":"Codes for high level observation categories.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A code that classifies the general type of observation being made.","id":"Observation.category","isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.category","requirements":"Used for filtering what observations are retrieved and displayed.","short":"Classification of type of observation","type":[{"code":"CodeableConcept"}]},{"alias":["Name"],"base":{"max":"1","min":1,"path":"Observation.code"},"binding":{"description":"Codes identifying names of simple observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"comment":"*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Describes what was observed. Sometimes this is called the observation \"name\".","id":"Observation.code","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"},{"identity":"sct-attr","map":"116680003 |Is a|"}],"max":"1","min":1,"mustSupport":false,"path":"Observation.code","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","short":"Type of observation (code / type)","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Observation.subject"},"comment":"One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.","id":"Observation.subject","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"participation[typeCode=RTGT]"},{"identity":"w5","map":"FiveWs.subject"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.subject","requirements":"Observations have no value if you don't know who or what they're about.","short":"Who and/or what the observation is about","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Location","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/Medication","http://hl7.org/fhir/StructureDefinition/Substance"]}]},{"base":{"max":"*","min":0,"path":"Observation.focus"},"comment":"Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [focusCode](extension-observation-focuscode.html).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"id":"Observation.focus","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"participation[typeCode=SBJ]"},{"identity":"w5","map":"FiveWs.subject"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.focus","short":"What the observation is about, when it is not about the subject of record","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}]},{"alias":["Context"],"base":{"max":"1","min":0,"path":"Observation.encounter"},"comment":"This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.","id":"Observation.encounter","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.context"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1"},{"identity":"rim","map":"inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.encounter","requirements":"For some observations it may be important to know the link between an observation and a particular encounter.","short":"Healthcare event during which this observation is made","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}]},{"alias":["Occurrence"],"base":{"max":"1","min":0,"path":"Observation.effective[x]"},"comment":"At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Observation.effective[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"},{"identity":"rim","map":"effectiveTime"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.effective[x]","requirements":"Knowing when an observation was deemed true is important to its relevance as well as determining trends.","short":"Clinically relevant time/time-period for observation","type":[{"code":"dateTime"},{"code":"Period"},{"code":"Timing"},{"code":"instant"}]},{"base":{"max":"1","min":0,"path":"Observation.issued"},"comment":"For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","id":"Observation.issued","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"},{"identity":"rim","map":"participation[typeCode=AUT].time"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.issued","short":"Date/Time this version was made available","type":[{"code":"instant"}]},{"base":{"max":"*","min":0,"path":"Observation.performer"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Who was responsible for asserting the observed value as \"true\".","id":"Observation.performer","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"v2","map":"OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"},{"identity":"rim","map":"participation[typeCode=PRF]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.performer","requirements":"May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","short":"Who is responsible for the observation","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}]},{"base":{"max":"1","min":0,"path":"Observation.value[x]"},"comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.","condition":["obs-7"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The information determined as a result of making the observation, if the information has a simple value.","id":"Observation.value[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX.2, OBX.5, OBX.6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.value[x]","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","short":"Actual result","type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"}]},{"base":{"max":"1","min":0,"path":"Observation.dataAbsentReason"},"binding":{"description":"Codes specifying why the result (`Observation.value[x]`) is missing.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"comment":"Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.","condition":["obs-6"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Provides a reason why the expected value in the element Observation.value[x] is missing.","id":"Observation.dataAbsentReason","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.dataAbsentReason","requirements":"For many results it is necessary to handle exceptional values in measurements.","short":"Why the result is missing","type":[{"code":"CodeableConcept"}]},{"alias":["Abnormal Flag"],"base":{"max":"*","min":0,"path":"Observation.interpretation"},"binding":{"description":"Codes identifying interpretations of observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A categorical assessment of an observation value. For example, high, low, normal.","id":"Observation.interpretation","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.interpretation","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","short":"High, low, normal, etc.","type":[{"code":"CodeableConcept"}]},{"base":{"max":"*","min":0,"path":"Observation.note"},"comment":"May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Comments about the observation or the results.","id":"Observation.note","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"},{"identity":"rim","map":"subjectOf.observationEvent[code=\"annotation\"].value"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.note","requirements":"Need to be able to provide free text additional information.","short":"Comments about the observation","type":[{"code":"Annotation"}]},{"base":{"max":"1","min":0,"path":"Observation.bodySite"},"binding":{"description":"SNOMED CT Body site concepts","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"comment":"Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Indicates the site on the subject's body where the observation was made (i.e. the target site).","id":"Observation.bodySite","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123037004 |Body structure|"},{"identity":"v2","map":"OBX-20"},{"identity":"rim","map":"targetSiteCode"},{"identity":"sct-attr","map":"718497002 |Inherent location|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.bodySite","short":"Observed body part","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Observation.method"},"binding":{"description":"Methods for simple observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationMethod"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/observation-methods"},"comment":"Only used if not implicit in code for Observation.code.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Indicates the mechanism used to perform the observation.","id":"Observation.method","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-17"},{"identity":"rim","map":"methodCode"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.method","requirements":"In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","short":"How it was done","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Observation.specimen"},"comment":"Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The specimen that was used when this observation was made.","id":"Observation.specimen","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123038009 |Specimen|"},{"identity":"v2","map":"SPM segment"},{"identity":"rim","map":"participation[typeCode=SPC].specimen"},{"identity":"sct-attr","map":"704319004 |Inherent in|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.specimen","short":"Specimen used for this observation","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Specimen"]}]},{"base":{"max":"1","min":0,"path":"Observation.device"},"comment":"Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The device used to generate the observation data.","id":"Observation.device","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 49062001 |Device|"},{"identity":"v2","map":"OBX-17 / PRT -10"},{"identity":"rim","map":"participation[typeCode=DEV]"},{"identity":"sct-attr","map":"424226004 |Using device|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.device","short":"(Measurement) Device","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}]},{"base":{"max":"*","min":0,"path":"Observation.referenceRange"},"comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"low.exists() or high.exists() or text.exists()","human":"Must have at least a low or a high or text","key":"obs-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Observation","xpath":"(exists(f:low) or exists(f:high)or exists(f:text))"}],"definition":"Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.","id":"Observation.referenceRange","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX.7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.referenceRange","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","short":"Provides guide for interpretation","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Observation.referenceRange.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Observation.referenceRange.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"Observation.referenceRange.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Observation.referenceRange.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Observation.referenceRange.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Observation.referenceRange.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"Observation.referenceRange.low"},"condition":["obs-3"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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).","id":"Observation.referenceRange.low","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.low"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.low","short":"Low Range, if relevant","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}]},{"base":{"max":"1","min":0,"path":"Observation.referenceRange.high"},"condition":["obs-3"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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).","id":"Observation.referenceRange.high","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.high"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.high","short":"High Range, if relevant","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}]},{"base":{"max":"1","min":0,"path":"Observation.referenceRange.type"},"binding":{"description":"Code for the meaning of a reference range.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeMeaning"}],"strength":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-meaning"},"comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","id":"Observation.referenceRange.type","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.type","requirements":"Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.","short":"Reference range qualifier","type":[{"code":"CodeableConcept"}]},{"base":{"max":"*","min":0,"path":"Observation.referenceRange.appliesTo"},"binding":{"description":"Codes identifying the population the reference range applies to.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeType"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-appliesto"},"comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Observation.referenceRange.appliesTo","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.referenceRange.appliesTo","requirements":"Need to be able to identify the target population for proper interpretation.","short":"Reference range population","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Observation.referenceRange.age"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Observation.referenceRange.age","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.age","requirements":"Some analytes vary greatly over age.","short":"Applicable age range, if relevant","type":[{"code":"Range"}]},{"base":{"max":"1","min":0,"path":"Observation.referenceRange.text"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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\".","id":"Observation.referenceRange.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:ST"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.referenceRange.text","short":"Text based reference range in an observation","type":[{"code":"string"}]},{"base":{"max":"*","min":0,"path":"Observation.hasMember"},"comment":"When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Observation.hasMember","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":"outBoundRelationship"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.hasMember","short":"Related resource that belongs to the Observation group","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}]},{"base":{"max":"*","min":0,"path":"Observation.derivedFrom"},"comment":"All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Observation.derivedFrom","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":".targetObservation"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.derivedFrom","short":"Related measurements the observation is made from","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}]},{"base":{"max":"*","min":0,"path":"Observation.component"},"comment":"For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.","id":"Observation.component","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"containment by OBX-4?"},{"identity":"rim","map":"outBoundRelationship[typeCode=COMP]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.component","requirements":"Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.","short":"Component results","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Observation.component.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Observation.component.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"Observation.component.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Observation.component.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Observation.component.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Observation.component.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"Observation.component.code"},"binding":{"description":"Codes identifying names of simple observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"comment":"*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Describes what was observed. Sometimes this is called the observation \"code\".","id":"Observation.component.code","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"}],"max":"1","min":1,"mustSupport":false,"path":"Observation.component.code","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","short":"Type of component observation (code / type)","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Observation.component.value[x]"},"comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The information determined as a result of making the observation, if the information has a simple value.","id":"Observation.component.value[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX.2, OBX.5, OBX.6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.component.value[x]","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","short":"Actual component result","type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"}]},{"base":{"max":"1","min":0,"path":"Observation.component.dataAbsentReason"},"binding":{"description":"Codes specifying why the result (`Observation.value[x]`) is missing.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"comment":"\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.","condition":["obs-6"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Provides a reason why the expected value in the element Observation.component.value[x] is missing.","id":"Observation.component.dataAbsentReason","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}],"max":"1","min":0,"mustSupport":false,"path":"Observation.component.dataAbsentReason","requirements":"For many results it is necessary to handle exceptional values in measurements.","short":"Why the component result is missing","type":[{"code":"CodeableConcept"}]},{"alias":["Abnormal Flag"],"base":{"max":"*","min":0,"path":"Observation.component.interpretation"},"binding":{"description":"Codes identifying interpretations of observations.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A categorical assessment of an observation value. For example, high, low, normal.","id":"Observation.component.interpretation","isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.component.interpretation","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","short":"High, low, normal, etc.","type":[{"code":"CodeableConcept"}]},{"base":{"max":"*","min":0,"path":"Observation.component.referenceRange"},"comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"contentReference":"#Observation.referenceRange","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range.","id":"Observation.component.referenceRange","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX.7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}],"max":"*","min":0,"mustSupport":false,"path":"Observation.component.referenceRange","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","short":"Provides guide for interpretation of component result"}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Observation NDomainResourceMeasurements and simple assertions
+ Rule: dataAbsentReason SHALL only be present if Observation.value[x] is not present
+ Rule: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier Σ0..*IdentifierBusiness Identifier for observation
\".\"\".\"\".\" instantiates[x] Σ0..1Instantiates FHIR ObservationDefinition
\".\"\".\"\".\"\".\" instantiatesCanonicalcanonical(ObservationDefinition)
\".\"\".\"\".\"\".\" instantiatesReferenceReference(ObservationDefinition)
\".\"\".\"\".\" basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
\".\"\".\"\".\" partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationUsage | Procedure | Immunization | ImagingStudy)Part of referenced event
\".\"\".\"\".\" status ?!Σ1..1coderegistered | preliminary | final | amended +
ObservationStatus (Required)
\".\"\".\"\".\" category 0..*CodeableConceptClassification of type of observation
Observation Category Codes (Preferred)
\".\"\".\"\".\" code Σ1..1CodeableConceptType of observation (code / type)
LOINC Codes (Example)
\".\"\".\"\".\" subject Σ0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)Who and/or what the observation is about
\".\"\".\"\".\" focus ΣTU0..*Reference(Any)What the observation is about, when it is not about the subject of record
\".\"\".\"\".\" encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
\".\"\".\"\".\" effective[x] Σ0..1Clinically relevant time/time-period for observation
\".\"\".\"\".\"\".\" effectiveDateTimedateTime
\".\"\".\"\".\"\".\" effectivePeriodPeriod
\".\"\".\"\".\"\".\" effectiveTimingTiming
\".\"\".\"\".\"\".\" effectiveInstantinstant
\".\"\".\"\".\" issued Σ0..1instantDate/Time this version was made available
\".\"\".\"\".\" performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
\".\"\".\"\".\" value[x] ΣI0..1Actual result
\".\"\".\"\".\"\".\" valueQuantityQuantity
\".\"\".\"\".\"\".\" valueCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\" valueStringstring
\".\"\".\"\".\"\".\" valueBooleanboolean
\".\"\".\"\".\"\".\" valueIntegerinteger
\".\"\".\"\".\"\".\" valueRangeRange
\".\"\".\"\".\"\".\" valueRatioRatio
\".\"\".\"\".\"\".\" valueSampledDataSampledData
\".\"\".\"\".\"\".\" valueTimetime
\".\"\".\"\".\"\".\" valueDateTimedateTime
\".\"\".\"\".\"\".\" valuePeriodPeriod
\".\"\".\"\".\"\".\" valueAttachmentAttachment
\".\"\".\"\".\" dataAbsentReason I0..1CodeableConceptWhy the result is missing
DataAbsentReason (Extensible)
\".\"\".\"\".\" interpretation 0..*CodeableConceptHigh, low, normal, etc.
Observation Interpretation Codes (Extensible)
\".\"\".\"\".\" note 0..*AnnotationComments about the observation
\".\"\".\"\".\" bodySite 0..1CodeableConceptObserved body part
SNOMED CT Body Structures (Example)
\".\"\".\"\".\" method 0..1CodeableConceptHow it was done
Observation Methods (Example)
\".\"\".\"\".\" specimen 0..1Reference(Specimen)Specimen used for this observation
\".\"\".\"\".\" device 0..1Reference(Device | DeviceMetric)(Measurement) Device
\".\"\".\"\".\" referenceRange I0..*BackboneElementProvides guide for interpretation
+ Rule: Must have at least a low or a high or text
\".\"\".\"\".\"\".\" low I0..1SimpleQuantityLow Range, if relevant
\".\"\".\"\".\"\".\" high I0..1SimpleQuantityHigh Range, if relevant
\".\"\".\"\".\"\".\" type 0..1CodeableConceptReference range qualifier
Observation Reference Range Meaning Codes (Preferred)
\".\"\".\"\".\"\".\" appliesTo 0..*CodeableConceptReference range population
Observation Reference Range Applies To Codes (Example)
\".\"\".\"\".\"\".\" age 0..1RangeApplicable age range, if relevant
\".\"\".\"\".\"\".\" text 0..1stringText based reference range in an observation
\".\"\".\"\".\" hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
\".\"\".\"\".\" derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
\".\"\".\"\".\" component Σ0..*BackboneElementComponent results
\".\"\".\"\".\"\".\" code Σ1..1CodeableConceptType of component observation (code / type)
LOINC Codes (Example)
\".\"\".\"\".\"\".\" value[x] Σ0..1Actual component result
\".\"\".\"\".\"\".\"\".\" valueQuantityQuantity
\".\"\".\"\".\"\".\"\".\" valueCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\"\".\" valueStringstring
\".\"\".\"\".\"\".\"\".\" valueBooleanboolean
\".\"\".\"\".\"\".\"\".\" valueIntegerinteger
\".\"\".\"\".\"\".\"\".\" valueRangeRange
\".\"\".\"\".\"\".\"\".\" valueRatioRatio
\".\"\".\"\".\"\".\"\".\" valueSampledDataSampledData
\".\"\".\"\".\"\".\"\".\" valueTimetime
\".\"\".\"\".\"\".\"\".\" valueDateTimedateTime
\".\"\".\"\".\"\".\"\".\" valuePeriodPeriod
\".\"\".\"\".\"\".\"\".\" valueAttachmentAttachment
\".\"\".\"\".\"\".\" dataAbsentReason I0..1CodeableConceptWhy the component result is missing
DataAbsentReason (Extensible)
\".\"\".\"\".\"\".\" interpretation 0..*CodeableConceptHigh, low, normal, etc.
Observation Interpretation Codes (Extensible)
\".\"\".\"\".\"\".\" referenceRange 0..*see referenceRangeProvides guide for interpretation of component result

\"doco\" Documentation for this format
","status":"generated"},"type":"Observation","url":"http://hl7.org/fhir/StructureDefinition/Observation","version":"4.6.0"} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Observation","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Observation\n \n \n N\n \n \n DomainResource\n Measurements and simple assertions\n
\n + Rule: dataAbsentReason SHALL only be present if Observation.value[x] is not present\n
\n + Rule: If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).\n
\n + Rule: bodyStructure SHALL only be present if Observation.bodySite is not present\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n 0..*\n Identifier\n Business Identifier for observation\n
\n
\n
\n \".\"\n \".\"\n \".\" \n instantiates[x]\n \n \n Σ\n TU\n 0..1\n Instantiates FHIR ObservationDefinition\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" instantiatesCanonical\n \n \n \n canonical(\n ObservationDefinition)\n \n
\n \".\"\n \".\"\n \".\"\n \".\" instantiatesReference\n \n \n \n Reference(\n ObservationDefinition)\n \n
\n \".\"\n \".\"\n \".\" \n basedOn\n \n \n Σ\n 0..*\n Reference(\n CarePlan | \n DeviceRequest | \n ImmunizationRecommendation | \n MedicationRequest | \n NutritionOrder | \n ServiceRequest)\n Fulfills plan, proposal or order\n
\n
\n
\n \".\"\n \".\"\n \".\" \n triggeredBy\n \n \n TU\n 0..*\n BackboneElement\n Triggering observation(s)\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n observation\n \n \n Σ\n 1..1\n Reference(\n Observation)\n Triggering observation\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n type\n \n \n Σ\n 1..1\n code\n reflex | repeat | re-run\n
Binding: \n triggered Bytype (\n Required)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n reason\n \n \n 0..1\n string\n Reason that the observation was triggered\n
\n
\n \".\"\n \".\"\n \".\" \n partOf\n \n \n Σ\n 0..*\n Reference(\n MedicationAdministration | \n MedicationDispense | \n MedicationStatement | \n Procedure | \n Immunization | \n ImagingStudy | \n GenomicStudy)\n Part of referenced event\n
\n
\n
\n \".\"\n \".\"\n \".\" \n status\n \n \n ?!\n Σ\n 1..1\n code\n registered | preliminary | final | amended +\n
Binding: \n Observation Status (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n category\n \n \n 0..*\n CodeableConcept\n Classification of type of observation\n
Binding: \n Observation Category Codes (\n Preferred)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n code\n \n \n Σ\n C\n 1..1\n CodeableConcept\n Type of observation (code / type)\n
Binding: \n LOINC Codes (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n subject\n \n \n Σ\n 0..1\n Reference(\n Patient | \n Group | \n Device | \n Location | \n Organization | \n Procedure | \n Practitioner | \n Medication | \n Substance | \n BiologicallyDerivedProduct | \n NutritionProduct)\n Who and/or what the observation is about\n
\n
\n \".\"\n \".\"\n \".\" \n focus\n \n \n Σ\n TU\n 0..*\n Reference(\n Any)\n What the observation is about, when it is not about the subject of record\n
\n
\n
\n \".\"\n \".\"\n \".\" \n encounter\n \n \n Σ\n 0..1\n Reference(\n Encounter)\n Healthcare event during which this observation is made\n
\n
\n \".\"\n \".\"\n \".\" \n effective[x]\n \n \n Σ\n 0..1\n Clinically relevant time/time-period for observation\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n effectiveDateTime\n \n \n \n dateTime\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n effectivePeriod\n \n \n \n Period\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n effectiveTiming\n \n \n \n Timing\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n effectiveInstant\n \n \n \n instant\n \n
\n \".\"\n \".\"\n \".\" \n issued\n \n \n Σ\n 0..1\n instant\n Date/Time this version was made available\n
\n
\n \".\"\n \".\"\n \".\" \n performer\n \n \n Σ\n 0..*\n Reference(\n Practitioner | \n PractitionerRole | \n Organization | \n CareTeam | \n Patient | \n RelatedPerson)\n Who is responsible for the observation\n
\n
\n
\n \".\"\n \".\"\n \".\" \n value[x]\n \n \n Σ\n C\n 0..1\n Actual result\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueQuantity\n \n \n \n Quantity\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueCodeableConcept\n \n \n \n CodeableConcept\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueString\n \n \n \n string\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueBoolean\n \n \n \n boolean\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueInteger\n \n \n \n integer\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueRange\n \n \n \n Range\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueRatio\n \n \n \n Ratio\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueSampledData\n \n \n \n SampledData\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueTime\n \n \n \n time\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueDateTime\n \n \n \n dateTime\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valuePeriod\n \n \n \n Period\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n valueAttachment\n \n \n \n Attachment\n \n
\n \".\"\n \".\"\n \".\"\n \".\" valueReference\n \n \n \n Reference(\n MolecularSequence)\n \n
\n \".\"\n \".\"\n \".\" \n dataAbsentReason\n \n \n C\n 0..1\n CodeableConcept\n Why the result is missing\n
Binding: \n Data Absent Reason (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\" \n interpretation\n \n \n 0..*\n CodeableConcept\n High, low, normal, etc\n
Binding: \n Observation Interpretation Codes (\n Extensible)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n note\n \n \n 0..*\n Annotation\n Comments about the observation\n
\n
\n
\n \".\"\n \".\"\n \".\" \n bodySite\n \n \n C\n 0..1\n CodeableConcept\n Observed body part\n
Binding: \n SNOMED CT Body Structures (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n bodyStructure\n \n \n C\n TU\n 0..1\n Reference(\n BodyStructure)\n Observed body structure\n
\n
\n \".\"\n \".\"\n \".\" \n method\n \n \n 0..1\n CodeableConcept\n How it was done\n
Binding: \n Observation Methods (\n Example)\n
\n
\n \".\"\n \".\"\n \".\" \n specimen\n \n \n C\n 0..1\n Reference(\n Specimen | \n Group)\n Specimen used for this observation\n
\n + Rule: If Observation.specimen is a reference to Group, the group can only have specimens\n
\n
\n \".\"\n \".\"\n \".\" \n device\n \n \n 0..1\n Reference(\n Device | \n DeviceMetric)\n A reference to the device that generates the measurements or the device settings for the device\n
\n
\n \".\"\n \".\"\n \".\" \n referenceRange\n \n \n C\n 0..*\n BackboneElement\n Provides guide for interpretation\n
\n + Rule: Must have at least a low or a high or text\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n low\n \n \n C\n 0..1\n SimpleQuantity\n Low Range, if relevant\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n high\n \n \n C\n 0..1\n SimpleQuantity\n High Range, if relevant\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n normalValue\n \n \n TU\n 0..1\n CodeableConcept\n Normal value, if relevant\n
Binding: \n Observation Reference Range Normal Value Codes (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n type\n \n \n TU\n 0..1\n CodeableConcept\n Reference range qualifier\n
Binding: \n Observation Reference Range Meaning Codes (\n Preferred)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n appliesTo\n \n \n 0..*\n CodeableConcept\n Reference range population\n
Binding: \n Observation Reference Range Applies To Codes (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n age\n \n \n 0..1\n Range\n Applicable age range, if relevant\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n text\n \n \n C\n 0..1\n markdown\n Text based reference range in an observation\n
\n
\n \".\"\n \".\"\n \".\" \n hasMember\n \n \n Σ\n 0..*\n Reference(\n Observation | \n QuestionnaireResponse | \n MolecularSequence)\n Related resource that belongs to the Observation group\n
\n
\n
\n \".\"\n \".\"\n \".\" \n derivedFrom\n \n \n Σ\n 0..*\n Reference(\n DocumentReference | \n ImagingStudy | \n ImagingSelection | \n QuestionnaireResponse | \n Observation | \n MolecularSequence | \n GenomicStudy)\n Related resource from which the observation is made\n
\n
\n
\n \".\"\n \".\"\n \".\" \n component\n \n \n Σ\n C\n 0..*\n BackboneElement\n Component results\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n code\n \n \n Σ\n C\n 1..1\n CodeableConcept\n Type of component observation (code / type)\n
Binding: \n LOINC Codes (\n Example)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n value[x]\n \n \n Σ\n 0..1\n Actual component result\n
\n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueQuantity\n \n \n \n Quantity\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueCodeableConcept\n \n \n \n CodeableConcept\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueString\n \n \n \n string\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueBoolean\n \n \n \n boolean\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueInteger\n \n \n \n integer\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueRange\n \n \n \n Range\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueRatio\n \n \n \n Ratio\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueSampledData\n \n \n \n SampledData\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueTime\n \n \n \n time\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueDateTime\n \n \n \n dateTime\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valuePeriod\n \n \n \n Period\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" \n valueAttachment\n \n \n \n Attachment\n \n
\n \".\"\n \".\"\n \".\"\n \".\"\n \".\" valueReference\n \n \n \n Reference(\n MolecularSequence)\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n dataAbsentReason\n \n \n 0..1\n CodeableConcept\n Why the component result is missing\n
Binding: \n Data Absent Reason (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n interpretation\n \n \n 0..*\n CodeableConcept\n High, low, normal, etc\n
Binding: \n Observation Interpretation Codes (\n Extensible)\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n referenceRange\n \n \n 0..*see \n referenceRange\n Provides guide for interpretation of component result\n
\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Clinical.Diagnostics"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"oo"}],"url":"http://hl7.org/fhir/StructureDefinition/Observation","version":"5.0.0","name":"Observation","status":"active","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (Orders and Observations)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/orders/index.cfm"}]}],"description":"Measurements and simple assertions made about a patient, device or other subject.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"purpose":"Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.","fhirVersion":"5.0.0","mapping":[{"identity":"workflow","uri":"http://hl7.org/fhir/workflow","name":"Workflow Pattern"},{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"sct-concept","uri":"http://snomed.info/conceptdomain","name":"SNOMED CT Concept Domain Binding"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"sct-attr","uri":"http://snomed.org/attributebinding","name":"SNOMED CT Attribute Binding"}],"kind":"resource","abstract":false,"type":"Observation","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"Observation","path":"Observation","short":"Measurements and simple assertions","definition":"Measurements and simple assertions made about a patient, device or other subject.","comment":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.","alias":["Vital Signs","Measurement","Results","Tests"],"min":0,"max":"*","base":{"path":"Observation","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"obs-6","severity":"error","human":"dataAbsentReason SHALL only be present if Observation.value[x] is not present","expression":"dataAbsentReason.empty() or value.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-7","severity":"error","human":"If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).","expression":"value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-8","severity":"error","human":"bodyStructure SHALL only be present if Observation.bodySite is not present","expression":"bodySite.exists() implies bodyStructure.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Observation[classCode=OBS, moodCode=EVN]"},{"identity":"workflow","map":"Event"},{"identity":"w5","map":"clinical.diagnostics"},{"identity":"sct-concept","map":"< 363787002 |Observable entity|"},{"identity":"v2","map":"OBX"}]},{"id":"Observation.id","path":"Observation.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.meta","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.implicitRules","path":"Observation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Observation.language","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Observation.text","path":"Observation.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Observation.contained","path":"Observation.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.extension","path":"Observation.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.modifierExtension","path":"Observation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.identifier","path":"Observation.identifier","short":"Business Identifier for observation","definition":"A unique identifier assigned to this observation.","requirements":"Allows observations to be distinguished and referenced.","min":0,"max":"*","base":{"path":"Observation.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"OBX-21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 3) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."},{"identity":"rim","map":"id"}]},{"id":"Observation.instantiates[x]","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.instantiates[x]","short":"Instantiates FHIR ObservationDefinition","definition":"The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.","comment":"ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.","min":0,"max":"1","base":{"path":"Observation.instantiates[x]","min":0,"max":"1"},"type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"Observation.basedOn","path":"Observation.basedOn","short":"Fulfills plan, proposal or order","definition":"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.","requirements":"Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","alias":["Fulfills"],"min":0,"max":"*","base":{"path":"Observation.basedOn","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.basedOn"},{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.triggeredBy","short":"Triggering observation(s)","definition":"Identifies the observation(s) that triggered the performance of this observation.","min":0,"max":"*","base":{"path":"Observation.triggeredBy","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy.id","path":"Observation.triggeredBy.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.extension","path":"Observation.triggeredBy.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.modifierExtension","path":"Observation.triggeredBy.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.triggeredBy.observation","path":"Observation.triggeredBy.observation","short":"Triggering observation","definition":"Reference to the triggering observation.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.observation","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.triggeredBy.type","path":"Observation.triggeredBy.type","short":"reflex | repeat | re-run","definition":"The type of trigger.\nReflex | Repeat | Re-run.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TriggeredByType"}],"strength":"required","description":"The type of TriggeredBy Observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-triggeredbytype|5.0.0"},"mapping":[{"identity":"rim","map":"code"}]},{"id":"Observation.triggeredBy.reason","path":"Observation.triggeredBy.reason","short":"Reason that the observation was triggered","definition":"Provides the reason why this observation was performed as a result of the observation(s) referenced.","min":0,"max":"1","base":{"path":"Observation.triggeredBy.reason","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"annotation"}]},{"id":"Observation.partOf","path":"Observation.partOf","short":"Part of referenced event","definition":"A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.","comment":"To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.","alias":["Container"],"min":0,"max":"*","base":{"path":"Observation.partOf","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationAdministration","http://hl7.org/fhir/StructureDefinition/MedicationDispense","http://hl7.org/fhir/StructureDefinition/MedicationStatement","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Immunization","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/GenomicStudy"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.partOf"},{"identity":"v2","map":"Varies by domain"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target"}]},{"id":"Observation.status","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint","valueString":"default: final"}],"path":"Observation.status","short":"registered | preliminary | final | amended +","definition":"The status of the result value.","comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","requirements":"Need to track the status of individual results. Some results are finalized before the whole report is finalized.","min":1,"max":"1","base":{"path":"Observation.status","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationStatus"}],"strength":"required","description":"Codes providing the status of an observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-status|5.0.0"},"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 445584004 |Report by finality status|"},{"identity":"v2","map":"OBX-11"},{"identity":"rim","map":"status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}]},{"id":"Observation.category","path":"Observation.category","short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":0,"max":"*","base":{"path":"Observation.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.code","path":"Observation.code","short":"Type of observation (code / type)","definition":"Describes what was observed. Sometimes this is called the observation \"name\".","comment":"*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","alias":["Name"],"min":1,"max":"1","base":{"path":"Observation.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","description":"Codes identifying names of simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"},{"identity":"sct-attr","map":"116680003 |Is a|"}]},{"id":"Observation.subject","path":"Observation.subject","short":"Who and/or what the observation is about","definition":"The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.","comment":"One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).","requirements":"Observations have no value if you don't know who or what they're about.","min":0,"max":"1","base":{"path":"Observation.subject","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Location","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/Medication","http://hl7.org/fhir/StructureDefinition/Substance","http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct","http://hl7.org/fhir/StructureDefinition/NutritionProduct"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"participation[typeCode=RTGT]"}]},{"id":"Observation.focus","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.focus","short":"What the observation is about, when it is not about the subject of record","definition":"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.","comment":"Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).","min":0,"max":"*","base":{"path":"Observation.focus","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"participation[typeCode=SBJ]"}]},{"id":"Observation.encounter","path":"Observation.encounter","short":"Healthcare event during which this observation is made","definition":"The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.","comment":"This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).","requirements":"For some observations it may be important to know the link between an observation and a particular encounter.","alias":["Context"],"min":0,"max":"1","base":{"path":"Observation.encounter","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.encounter"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1"},{"identity":"rim","map":"inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]},{"id":"Observation.effective[x]","path":"Observation.effective[x]","short":"Clinically relevant time/time-period for observation","definition":"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.","comment":"At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","requirements":"Knowing when an observation was deemed true is important to its relevance as well as determining trends.","alias":["Occurrence"],"min":0,"max":"1","base":{"path":"Observation.effective[x]","min":0,"max":"1"},"type":[{"code":"dateTime"},{"code":"Period"},{"code":"Timing"},{"code":"instant"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"},{"identity":"rim","map":"effectiveTime"}]},{"id":"Observation.issued","path":"Observation.issued","short":"Date/Time this version was made available","definition":"The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","comment":"For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.","min":0,"max":"1","base":{"path":"Observation.issued","min":0,"max":"1"},"type":[{"code":"instant"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"OBR-22 (or MSH-7), or perhaps OBX-19 (depends on who observation made)"},{"identity":"rim","map":"participation[typeCode=AUT].time"}]},{"id":"Observation.performer","path":"Observation.performer","short":"Who is responsible for the observation","definition":"Who was responsible for asserting the observed value as \"true\".","requirements":"May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","min":0,"max":"*","base":{"path":"Observation.performer","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"v2","map":"OBX-15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"},{"identity":"rim","map":"participation[typeCode=PRF]"}]},{"id":"Observation.value[x]","path":"Observation.value[x]","short":"Actual result","definition":"The information determined as a result of making the observation, if the information has a simple value.","comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","min":0,"max":"1","base":{"path":"Observation.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["obs-7","obs-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.dataAbsentReason","path":"Observation.dataAbsentReason","short":"Why the result is missing","definition":"Provides a reason why the expected value in the element Observation.value[x] is missing.","comment":"Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.interpretation","path":"Observation.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.note","path":"Observation.note","short":"Comments about the observation","definition":"Comments about the observation or the results.","comment":"May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.","requirements":"Need to be able to provide free text additional information.","min":0,"max":"*","base":{"path":"Observation.note","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE-3 (partner NTE to OBX, or sometimes another (child?) OBX)"},{"identity":"rim","map":"subjectOf.observationEvent[code=\"annotation\"].value"}]},{"id":"Observation.bodySite","path":"Observation.bodySite","short":"Observed body part","definition":"Indicates the site on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodySite","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","description":"SNOMED CT Body site concepts","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"mapping":[{"identity":"sct-concept","map":"< 123037004 |Body structure|"},{"identity":"v2","map":"OBX-20"},{"identity":"rim","map":"targetSiteCode"},{"identity":"sct-attr","map":"718497002 |Inherent location|"}]},{"id":"Observation.bodyStructure","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.bodyStructure","short":"Observed body structure","definition":"Indicates the body structure on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodyStructure","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/BodyStructure"]}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"targetSiteCode"}]},{"id":"Observation.method","path":"Observation.method","short":"How it was done","definition":"Indicates the mechanism used to perform the observation.","comment":"Only used if not implicit in code for Observation.code.","requirements":"In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","min":0,"max":"1","base":{"path":"Observation.method","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationMethod"}],"strength":"example","description":"Methods for simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-methods"},"mapping":[{"identity":"v2","map":"OBX-17"},{"identity":"rim","map":"methodCode"}]},{"id":"Observation.specimen","path":"Observation.specimen","short":"Specimen used for this observation","definition":"The specimen that was used when this observation was made.","comment":"Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).","min":0,"max":"1","base":{"path":"Observation.specimen","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Specimen","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-9","severity":"error","human":"If Observation.specimen is a reference to Group, the group can only have specimens","expression":"(reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123038009 |Specimen|"},{"identity":"v2","map":"SPM segment"},{"identity":"rim","map":"participation[typeCode=SPC].specimen"},{"identity":"sct-attr","map":"704319004 |Inherent in|"}]},{"id":"Observation.device","path":"Observation.device","short":"A reference to the device that generates the measurements or the device settings for the device","definition":"A reference to the device that generates the measurements or the device settings for the device.","comment":"Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.","min":0,"max":"1","base":{"path":"Observation.device","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 49062001 |Device|"},{"identity":"v2","map":"OBX-17 / PRT -10"},{"identity":"rim","map":"participation[typeCode=DEV]"},{"identity":"sct-attr","map":"424226004 |Using device|"}]},{"id":"Observation.referenceRange","path":"Observation.referenceRange","short":"Provides guide for interpretation","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.referenceRange","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-3","severity":"error","human":"Must have at least a low or a high or text","expression":"low.exists() or high.exists() or text.exists()","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]},{"id":"Observation.referenceRange.id","path":"Observation.referenceRange.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.extension","path":"Observation.referenceRange.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.modifierExtension","path":"Observation.referenceRange.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.referenceRange.low","path":"Observation.referenceRange.low","short":"Low Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.low","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.low"}]},{"id":"Observation.referenceRange.high","path":"Observation.referenceRange.high","short":"High Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.high","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.high"}]},{"id":"Observation.referenceRange.normalValue","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.normalValue","short":"Normal value, if relevant","definition":"The value of the normal value of the reference range.","min":0,"max":"1","base":{"path":"Observation.referenceRange.normalValue","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationReferenceRangeNormalValue"}],"strength":"extensible","description":"Codes identifying the normal value of the observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue"},"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.normal"}]},{"id":"Observation.referenceRange.type","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.type","short":"Reference range qualifier","definition":"Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.","requirements":"Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.","min":0,"max":"1","base":{"path":"Observation.referenceRange.type","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeMeaning"}],"strength":"preferred","description":"Code for the meaning of a reference range.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-meaning"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.appliesTo","path":"Observation.referenceRange.appliesTo","short":"Reference range population","definition":"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.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.","requirements":"Need to be able to identify the target population for proper interpretation.","min":0,"max":"*","base":{"path":"Observation.referenceRange.appliesTo","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeType"}],"strength":"example","description":"Codes identifying the population the reference range applies to.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-appliesto"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.age","path":"Observation.referenceRange.age","short":"Applicable age range, if relevant","definition":"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.","requirements":"Some analytes vary greatly over age.","min":0,"max":"1","base":{"path":"Observation.referenceRange.age","min":0,"max":"1"},"type":[{"code":"Range"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}]},{"id":"Observation.referenceRange.text","path":"Observation.referenceRange.text","short":"Text based reference range in an observation","definition":"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\".","min":0,"max":"1","base":{"path":"Observation.referenceRange.text","min":0,"max":"1"},"type":[{"code":"markdown"}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:ST"}]},{"id":"Observation.hasMember","path":"Observation.hasMember","short":"Related resource that belongs to the Observation group","definition":"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.","comment":"When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.","min":0,"max":"*","base":{"path":"Observation.hasMember","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.derivedFrom","path":"Observation.derivedFrom","short":"Related resource from which the observation is made","definition":"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.","comment":"All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.","min":0,"max":"*","base":{"path":"Observation.derivedFrom","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/ImagingSelection","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/GenomicStudy"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":".targetObservation"}]},{"id":"Observation.component","path":"Observation.component","short":"Component results","definition":"Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.","comment":"For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.","requirements":"Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.","min":0,"max":"*","base":{"path":"Observation.component","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"containment by OBX-4?"},{"identity":"rim","map":"outBoundRelationship[typeCode=COMP]"}]},{"id":"Observation.component.id","path":"Observation.component.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.extension","path":"Observation.component.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.modifierExtension","path":"Observation.component.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.component.code","path":"Observation.component.code","short":"Type of component observation (code / type)","definition":"Describes what was observed. Sometimes this is called the observation \"code\".","comment":"*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","min":1,"max":"1","base":{"path":"Observation.component.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","description":"Codes identifying names of simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"}]},{"id":"Observation.component.value[x]","path":"Observation.component.value[x]","short":"Actual component result","definition":"The information determined as a result of making the observation, if the information has a simple value.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","min":0,"max":"1","base":{"path":"Observation.component.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.dataAbsentReason","path":"Observation.component.dataAbsentReason","short":"Why the component result is missing","definition":"Provides a reason why the expected value in the element Observation.component.value[x] is missing.","comment":"\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.component.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.component.interpretation","path":"Observation.component.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.component.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.component.referenceRange","path":"Observation.component.referenceRange","short":"Provides guide for interpretation of component result","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.component.referenceRange","min":0,"max":"*"},"contentReference":"#Observation.referenceRange","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]}]},"differential":{"element":[{"id":"Observation","path":"Observation","short":"Measurements and simple assertions","definition":"Measurements and simple assertions made about a patient, device or other subject.","comment":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.","alias":["Vital Signs","Measurement","Results","Tests"],"min":0,"max":"*","constraint":[{"key":"obs-7","severity":"error","human":"If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).","expression":"value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-8","severity":"error","human":"bodyStructure SHALL only be present if Observation.bodySite is not present","expression":"bodySite.exists() implies bodyStructure.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-6","severity":"error","human":"dataAbsentReason SHALL only be present if Observation.value[x] is not present","expression":"dataAbsentReason.empty() or value.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"mapping":[{"identity":"workflow","map":"Event"},{"identity":"w5","map":"clinical.diagnostics"},{"identity":"sct-concept","map":"< 363787002 |Observable entity|"},{"identity":"v2","map":"OBX"},{"identity":"rim","map":"Observation[classCode=OBS, moodCode=EVN]"}]},{"id":"Observation.identifier","path":"Observation.identifier","short":"Business Identifier for observation","definition":"A unique identifier assigned to this observation.","requirements":"Allows observations to be distinguished and referenced.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"OBX-21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 3) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."},{"identity":"rim","map":"id"}]},{"id":"Observation.instantiates[x]","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.instantiates[x]","short":"Instantiates FHIR ObservationDefinition","definition":"The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.","comment":"ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.","min":0,"max":"1","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"Observation.basedOn","path":"Observation.basedOn","short":"Fulfills plan, proposal or order","definition":"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.","requirements":"Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","alias":["Fulfills"],"min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.basedOn"},{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.triggeredBy","short":"Triggering observation(s)","definition":"Identifies the observation(s) that triggered the performance of this observation.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy.observation","path":"Observation.triggeredBy.observation","short":"Triggering observation","definition":"Reference to the triggering observation.","min":1,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.triggeredBy.type","path":"Observation.triggeredBy.type","short":"reflex | repeat | re-run","definition":"The type of trigger.\nReflex | Repeat | Re-run.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TriggeredByType"}],"strength":"required","description":"The type of TriggeredBy Observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-triggeredbytype|5.0.0"},"mapping":[{"identity":"rim","map":"code"}]},{"id":"Observation.triggeredBy.reason","path":"Observation.triggeredBy.reason","short":"Reason that the observation was triggered","definition":"Provides the reason why this observation was performed as a result of the observation(s) referenced.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"annotation"}]},{"id":"Observation.partOf","path":"Observation.partOf","short":"Part of referenced event","definition":"A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.","comment":"To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.","alias":["Container"],"min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationAdministration","http://hl7.org/fhir/StructureDefinition/MedicationDispense","http://hl7.org/fhir/StructureDefinition/MedicationStatement","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Immunization","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/GenomicStudy"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.partOf"},{"identity":"v2","map":"Varies by domain"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target"}]},{"id":"Observation.status","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint","valueString":"default: final"}],"path":"Observation.status","short":"registered | preliminary | final | amended +","definition":"The status of the result value.","comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","requirements":"Need to track the status of individual results. Some results are finalized before the whole report is finalized.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationStatus"}],"strength":"required","description":"Codes providing the status of an observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-status|5.0.0"},"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 445584004 |Report by finality status|"},{"identity":"v2","map":"OBX-11"},{"identity":"rim","map":"status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}]},{"id":"Observation.category","path":"Observation.category","short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.code","path":"Observation.code","short":"Type of observation (code / type)","definition":"Describes what was observed. Sometimes this is called the observation \"name\".","comment":"*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","alias":["Name"],"min":1,"max":"1","type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","description":"Codes identifying names of simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"},{"identity":"sct-attr","map":"116680003 |Is a|"}]},{"id":"Observation.subject","path":"Observation.subject","short":"Who and/or what the observation is about","definition":"The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.","comment":"One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).","requirements":"Observations have no value if you don't know who or what they're about.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Group","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Location","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/Medication","http://hl7.org/fhir/StructureDefinition/Substance","http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct","http://hl7.org/fhir/StructureDefinition/NutritionProduct"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"participation[typeCode=RTGT]"}]},{"id":"Observation.focus","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.focus","short":"What the observation is about, when it is not about the subject of record","definition":"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.","comment":"Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"participation[typeCode=SBJ]"}]},{"id":"Observation.encounter","path":"Observation.encounter","short":"Healthcare event during which this observation is made","definition":"The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.","comment":"This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).","requirements":"For some observations it may be important to know the link between an observation and a particular encounter.","alias":["Context"],"min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.encounter"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1"},{"identity":"rim","map":"inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]},{"id":"Observation.effective[x]","path":"Observation.effective[x]","short":"Clinically relevant time/time-period for observation","definition":"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.","comment":"At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","requirements":"Knowing when an observation was deemed true is important to its relevance as well as determining trends.","alias":["Occurrence"],"min":0,"max":"1","type":[{"code":"dateTime"},{"code":"Period"},{"code":"Timing"},{"code":"instant"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"},{"identity":"rim","map":"effectiveTime"}]},{"id":"Observation.issued","path":"Observation.issued","short":"Date/Time this version was made available","definition":"The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","comment":"For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.","min":0,"max":"1","type":[{"code":"instant"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"OBR-22 (or MSH-7), or perhaps OBX-19 (depends on who observation made)"},{"identity":"rim","map":"participation[typeCode=AUT].time"}]},{"id":"Observation.performer","path":"Observation.performer","short":"Who is responsible for the observation","definition":"Who was responsible for asserting the observed value as \"true\".","requirements":"May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"v2","map":"OBX-15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"},{"identity":"rim","map":"participation[typeCode=PRF]"}]},{"id":"Observation.value[x]","path":"Observation.value[x]","short":"Actual result","definition":"The information determined as a result of making the observation, if the information has a simple value.","comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","min":0,"max":"1","type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["obs-7","obs-6"],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.dataAbsentReason","path":"Observation.dataAbsentReason","short":"Why the result is missing","definition":"Provides a reason why the expected value in the element Observation.value[x] is missing.","comment":"Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"condition":["obs-6"],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.interpretation","path":"Observation.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.note","path":"Observation.note","short":"Comments about the observation","definition":"Comments about the observation or the results.","comment":"May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.","requirements":"Need to be able to provide free text additional information.","min":0,"max":"*","type":[{"code":"Annotation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE-3 (partner NTE to OBX, or sometimes another (child?) OBX)"},{"identity":"rim","map":"subjectOf.observationEvent[code=\"annotation\"].value"}]},{"id":"Observation.bodySite","path":"Observation.bodySite","short":"Observed body part","definition":"Indicates the site on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"condition":["obs-8"],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","description":"SNOMED CT Body site concepts","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"mapping":[{"identity":"sct-concept","map":"< 123037004 |Body structure|"},{"identity":"v2","map":"OBX-20"},{"identity":"rim","map":"targetSiteCode"},{"identity":"sct-attr","map":"718497002 |Inherent location|"}]},{"id":"Observation.bodyStructure","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.bodyStructure","short":"Observed body structure","definition":"Indicates the body structure on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/BodyStructure"]}],"condition":["obs-8"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"targetSiteCode"}]},{"id":"Observation.method","path":"Observation.method","short":"How it was done","definition":"Indicates the mechanism used to perform the observation.","comment":"Only used if not implicit in code for Observation.code.","requirements":"In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationMethod"}],"strength":"example","description":"Methods for simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-methods"},"mapping":[{"identity":"v2","map":"OBX-17"},{"identity":"rim","map":"methodCode"}]},{"id":"Observation.specimen","path":"Observation.specimen","short":"Specimen used for this observation","definition":"The specimen that was used when this observation was made.","comment":"Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Specimen","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"obs-9","severity":"error","human":"If Observation.specimen is a reference to Group, the group can only have specimens","expression":"(reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123038009 |Specimen|"},{"identity":"v2","map":"SPM segment"},{"identity":"rim","map":"participation[typeCode=SPC].specimen"},{"identity":"sct-attr","map":"704319004 |Inherent in|"}]},{"id":"Observation.device","path":"Observation.device","short":"A reference to the device that generates the measurements or the device settings for the device","definition":"A reference to the device that generates the measurements or the device settings for the device.","comment":"Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 49062001 |Device|"},{"identity":"v2","map":"OBX-17 / PRT -10"},{"identity":"rim","map":"participation[typeCode=DEV]"},{"identity":"sct-attr","map":"424226004 |Using device|"}]},{"id":"Observation.referenceRange","path":"Observation.referenceRange","short":"Provides guide for interpretation","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"constraint":[{"key":"obs-3","severity":"error","human":"Must have at least a low or a high or text","expression":"low.exists() or high.exists() or text.exists()","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]},{"id":"Observation.referenceRange.low","path":"Observation.referenceRange.low","short":"Low Range, if relevant","definition":"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).","min":0,"max":"1","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.low"}]},{"id":"Observation.referenceRange.high","path":"Observation.referenceRange.high","short":"High Range, if relevant","definition":"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).","min":0,"max":"1","type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.high"}]},{"id":"Observation.referenceRange.normalValue","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.normalValue","short":"Normal value, if relevant","definition":"The value of the normal value of the reference range.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationReferenceRangeNormalValue"}],"strength":"extensible","description":"Codes identifying the normal value of the observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue"},"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.normal"}]},{"id":"Observation.referenceRange.type","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.type","short":"Reference range qualifier","definition":"Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.","requirements":"Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeMeaning"}],"strength":"preferred","description":"Code for the meaning of a reference range.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-meaning"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.appliesTo","path":"Observation.referenceRange.appliesTo","short":"Reference range population","definition":"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.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.","requirements":"Need to be able to identify the target population for proper interpretation.","min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeType"}],"strength":"example","description":"Codes identifying the population the reference range applies to.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-appliesto"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.age","path":"Observation.referenceRange.age","short":"Applicable age range, if relevant","definition":"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.","requirements":"Some analytes vary greatly over age.","min":0,"max":"1","type":[{"code":"Range"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}]},{"id":"Observation.referenceRange.text","path":"Observation.referenceRange.text","short":"Text based reference range in an observation","definition":"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\".","min":0,"max":"1","type":[{"code":"markdown"}],"condition":["obs-3"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:ST"}]},{"id":"Observation.hasMember","path":"Observation.hasMember","short":"Related resource that belongs to the Observation group","definition":"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.","comment":"When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.derivedFrom","path":"Observation.derivedFrom","short":"Related resource from which the observation is made","definition":"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.","comment":"All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/ImagingSelection","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/Observation","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/GenomicStudy"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":".targetObservation"}]},{"id":"Observation.component","path":"Observation.component","short":"Component results","definition":"Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.","comment":"For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.","requirements":"Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"condition":["obs-7"],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"containment by OBX-4?"},{"identity":"rim","map":"outBoundRelationship[typeCode=COMP]"}]},{"id":"Observation.component.code","path":"Observation.component.code","short":"Type of component observation (code / type)","definition":"Describes what was observed. Sometimes this is called the observation \"code\".","comment":"*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCode"}],"strength":"example","description":"Codes identifying names of simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-codes"},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"}]},{"id":"Observation.component.value[x]","path":"Observation.component.value[x]","short":"Actual component result","definition":"The information determined as a result of making the observation, if the information has a simple value.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","min":0,"max":"1","type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.dataAbsentReason","path":"Observation.component.dataAbsentReason","short":"Why the component result is missing","definition":"Provides a reason why the expected value in the element Observation.component.value[x] is missing.","comment":"\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.component.interpretation","path":"Observation.component.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.component.referenceRange","path":"Observation.component.referenceRange","short":"Provides guide for interpretation of component result","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","contentReference":"#Observation.referenceRange","mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Organization.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Organization.json index aba62222d..d4212b7a9 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Organization.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Organization.json @@ -1 +1 @@ -{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/pafm/index.cfm"}]}],"date":"2021-04-14T05:30:20+00:00","derivation":"specialization","description":"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.","differential":{"element":[{"constraint":[{"expression":"(identifier.count() + name.count()) > 0","human":"The organization SHALL at least have a name or an identifier, and possibly more than one","key":"org-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Organization","xpath":"count(f:identifier | f:name) > 0"}],"definition":"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.","id":"Organization","isModifier":false,"mapping":[{"identity":"v2","map":"(also see master files messages)"},{"identity":"rim","map":"Organization(classCode=ORG, determinerCode=INST)"},{"identity":"interface","map":"ParticipantContactable"},{"identity":"servd","map":"Organization"},{"identity":"w5","map":"administrative.group"}],"max":"*","min":0,"mustSupport":false,"path":"Organization","short":"A grouping of people or organizations with a common purpose"},{"condition":["org-1"],"definition":"Identifier for the organization that is used to identify the organization across multiple disparate systems.","id":"Organization.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"XON.10 / XON.3"},{"identity":"rim","map":".scopes[Role](classCode=IDENT)"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.identifier","requirements":"Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.","short":"Identifies this organization across multiple systems","type":[{"code":"Identifier"}]},{"comment":"This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.","definition":"Whether the organization's record is still in active use.","id":"Organization.active","isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"v2","map":"No equivalent in HL7 v2"},{"identity":"rim","map":".status"},{"identity":"interface","map":"Participant.active"},{"identity":"servd","map":"./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."}],"max":"1","meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","min":0,"mustSupport":false,"path":"Organization.active","requirements":"Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.","short":"Whether the organization's record is still in active use","type":[{"code":"boolean"}]},{"binding":{"description":"Used to categorize the organization.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"OrganizationType"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/organization-type"},"comment":"Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.","definition":"The kind(s) of organization that this is.","id":"Organization.type","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"v2","map":"No equivalent in v2"},{"identity":"rim","map":".code"},{"identity":"servd","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.type","requirements":"Need to be able to track the kind of organization that this is - different organization types have different uses.","short":"Kind of organization","type":[{"code":"CodeableConcept"}]},{"comment":"If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.","condition":["org-1"],"definition":"A name associated with the organization.","id":"Organization.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XON.1"},{"identity":"rim","map":".name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":".PreferredName/Name"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.name","requirements":"Need to use the name as the label of the organization.","short":"Name used for the organization","type":[{"code":"string"}]},{"comment":"There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.","definition":"A list of alternate names that the organization is known as, or was known as in the past.","id":"Organization.alias","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".name"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.alias","requirements":"Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.","short":"A list of alternate names that the organization is known as, or was known as in the past","type":[{"code":"string"}]},{"comment":"The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.","condition":["org-3"],"constraint":[{"expression":"where(use = 'home').empty()","human":"The telecom of an organization can never be of use 'home'","key":"org-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Organization","xpath":"count(f:use[@value='home']) = 0"}],"definition":"A contact detail for the organization.","id":"Organization.telecom","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC-22?"},{"identity":"rim","map":".telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"servd","map":"./ContactPoints"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.telecom","requirements":"Human contact for the organization.","short":"A contact detail for the organization","type":[{"code":"ContactPoint"}]},{"comment":"Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.","condition":["org-2"],"constraint":[{"expression":"where(use = 'home').empty()","human":"An address of an organization can never be of use 'home'","key":"org-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Organization","xpath":"count(f:use[@value='home']) = 0"}],"definition":"An address for the organization.","id":"Organization.address","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC-23?"},{"identity":"rim","map":".address"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"servd","map":"./PrimaryAddress and ./OtherAddresses"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.address","requirements":"May need to keep track of the organization's addresses for contacting, billing or reporting requirements.","short":"An address for the organization","type":[{"code":"Address"}]},{"definition":"The organization of which this organization forms a part.","id":"Organization.partOf","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"No equivalent in HL7 v2"},{"identity":"rim","map":".playedBy[classCode=Part].scoper"},{"identity":"servd","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.partOf","requirements":"Need to be able to track the hierarchy of organizations within an organization.","short":"The organization of which this organization forms a part","type":[{"code":"Reference","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"comment":"Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.","definition":"Contact for the organization for a certain purpose.","id":"Organization.contact","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".contactParty"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.contact","requirements":"Need to keep track of assigned contact points within bigger organization.","short":"Contact for the organization for a certain purpose","type":[{"code":"BackboneElement"}]},{"binding":{"description":"The purpose for which you would contact a contact party.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ContactPartyType"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/contactentity-type"},"definition":"Indicates a purpose for which the contact can be reached.","id":"Organization.contact.purpose","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"./type"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.contact.purpose","requirements":"Need to distinguish between multiple contact persons.","short":"The type of contact","type":[{"code":"CodeableConcept"}]},{"definition":"A name associated with the contact.","id":"Organization.contact.name","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-5, PID-9"},{"identity":"rim","map":"./name"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.contact.name","requirements":"Need to be able to track the person by name.","short":"A name associated with the contact","type":[{"code":"HumanName"}]},{"definition":"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.","id":"Organization.contact.telecom","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-13, PID-14"},{"identity":"rim","map":"./telecom"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.contact.telecom","requirements":"People have (primary) ways to contact them in some way such as phone, email.","short":"Contact details (telephone, email, etc.) for a contact","type":[{"code":"ContactPoint"}]},{"definition":"Visiting or postal addresses for the contact.","id":"Organization.contact.address","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-11"},{"identity":"rim","map":"./addr"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.contact.address","requirements":"May need to keep track of a contact party's address for contacting, billing or reporting requirements.","short":"Visiting or postal addresses for the contact","type":[{"code":"Address"}]},{"definition":"Technical endpoints providing access to services operated for the organization.","id":"Organization.endpoint","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.endpoint","requirements":"Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.","short":"Technical endpoints providing access to services operated for the organization","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}]}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":3},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"business"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pa"}],"fhirVersion":"4.6.0","id":"Organization","kind":"resource","mapping":[{"identity":"v2","name":"HL7 v2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"interface","name":"Interface Pattern","uri":"http://hl7.org/fhir/interface"},{"identity":"servd","name":"ServD","uri":"http://www.omg.org/spec/ServD/1.0/"},{"identity":"w5","name":"FiveWs Pattern Mapping","uri":"http://hl7.org/fhir/fivews"}],"meta":{"lastUpdated":"2021-04-14T05:30:20.096+00:00"},"name":"Organization","publisher":"Health Level Seven International (Patient Administration)","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"Organization"},"constraint":[{"expression":"contained.contained.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","key":"dom-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(parent::f:contained and f:contained)"},{"expression":"contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","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","key":"dom-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"},{"expression":"contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated","key":"dom-4","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"},{"expression":"contained.meta.security.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a security label","key":"dom-5","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:security))"},{"expression":"text.`div`.exists()","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"human":"A resource should have narrative for robust management","key":"dom-6","severity":"warning","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"exists(f:text/h:div)"},{"expression":"(identifier.count() + name.count()) > 0","human":"The organization SHALL at least have a name or an identifier, and possibly more than one","key":"org-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Organization","xpath":"count(f:identifier | f:name) > 0"}],"definition":"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.","id":"Organization","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act"},{"identity":"v2","map":"(also see master files messages)"},{"identity":"rim","map":"Organization(classCode=ORG, determinerCode=INST)"},{"identity":"interface","map":"ParticipantContactable"},{"identity":"servd","map":"Organization"},{"identity":"w5","map":"administrative.group"}],"max":"*","min":0,"mustSupport":false,"path":"Organization","short":"A grouping of people or organizations with a common purpose"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"Typically, the resource has an id except for cases like the create operation, conditional updates.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Organization.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Organization.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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.","id":"Organization.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Organization.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","id":"Organization.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Organization.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The base language in which the resource is written.","id":"Organization.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"Organization.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"Contained resources do not have a 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 information is added later.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Organization.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.","definition":"These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.","id":"Organization.contained","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"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.","id":"Organization.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Organization.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"base":{"max":"*","min":0,"path":"Organization.identifier"},"condition":["org-1"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Identifier for the organization that is used to identify the organization across multiple disparate systems.","id":"Organization.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"XON.10 / XON.3"},{"identity":"rim","map":".scopes[Role](classCode=IDENT)"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.identifier","requirements":"Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.","short":"Identifies this organization across multiple systems","type":[{"code":"Identifier"}]},{"base":{"max":"1","min":0,"path":"Organization.active"},"comment":"This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Whether the organization's record is still in active use.","id":"Organization.active","isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"v2","map":"No equivalent in HL7 v2"},{"identity":"rim","map":".status"},{"identity":"interface","map":"Participant.active"},{"identity":"servd","map":"./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."}],"max":"1","meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","min":0,"mustSupport":false,"path":"Organization.active","requirements":"Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.","short":"Whether the organization's record is still in active use","type":[{"code":"boolean"}]},{"base":{"max":"*","min":0,"path":"Organization.type"},"binding":{"description":"Used to categorize the organization.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"OrganizationType"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/organization-type"},"comment":"Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The kind(s) of organization that this is.","id":"Organization.type","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"v2","map":"No equivalent in v2"},{"identity":"rim","map":".code"},{"identity":"servd","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.type","requirements":"Need to be able to track the kind of organization that this is - different organization types have different uses.","short":"Kind of organization","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Organization.name"},"comment":"If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.","condition":["org-1"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A name associated with the organization.","id":"Organization.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XON.1"},{"identity":"rim","map":".name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":".PreferredName/Name"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.name","requirements":"Need to use the name as the label of the organization.","short":"Name used for the organization","type":[{"code":"string"}]},{"base":{"max":"*","min":0,"path":"Organization.alias"},"comment":"There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A list of alternate names that the organization is known as, or was known as in the past.","id":"Organization.alias","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".name"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.alias","requirements":"Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.","short":"A list of alternate names that the organization is known as, or was known as in the past","type":[{"code":"string"}]},{"base":{"max":"*","min":0,"path":"Organization.telecom"},"comment":"The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.","condition":["org-3"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"where(use = 'home').empty()","human":"The telecom of an organization can never be of use 'home'","key":"org-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Organization","xpath":"count(f:use[@value='home']) = 0"}],"definition":"A contact detail for the organization.","id":"Organization.telecom","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC-22?"},{"identity":"rim","map":".telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"servd","map":"./ContactPoints"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.telecom","requirements":"Human contact for the organization.","short":"A contact detail for the organization","type":[{"code":"ContactPoint"}]},{"base":{"max":"*","min":0,"path":"Organization.address"},"comment":"Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.","condition":["org-2"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"where(use = 'home').empty()","human":"An address of an organization can never be of use 'home'","key":"org-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Organization","xpath":"count(f:use[@value='home']) = 0"}],"definition":"An address for the organization.","id":"Organization.address","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC-23?"},{"identity":"rim","map":".address"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"servd","map":"./PrimaryAddress and ./OtherAddresses"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.address","requirements":"May need to keep track of the organization's addresses for contacting, billing or reporting requirements.","short":"An address for the organization","type":[{"code":"Address"}]},{"base":{"max":"1","min":0,"path":"Organization.partOf"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The organization of which this organization forms a part.","id":"Organization.partOf","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"No equivalent in HL7 v2"},{"identity":"rim","map":".playedBy[classCode=Part].scoper"},{"identity":"servd","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.partOf","requirements":"Need to be able to track the hierarchy of organizations within an organization.","short":"The organization of which this organization forms a part","type":[{"code":"Reference","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"base":{"max":"*","min":0,"path":"Organization.contact"},"comment":"Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Contact for the organization for a certain purpose.","id":"Organization.contact","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".contactParty"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.contact","requirements":"Need to keep track of assigned contact points within bigger organization.","short":"Contact for the organization for a certain purpose","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Organization.contact.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Organization.contact.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"Organization.contact.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Organization.contact.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Organization.contact.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Organization.contact.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"Organization.contact.purpose"},"binding":{"description":"The purpose for which you would contact a contact party.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ContactPartyType"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/contactentity-type"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Indicates a purpose for which the contact can be reached.","id":"Organization.contact.purpose","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"./type"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.contact.purpose","requirements":"Need to distinguish between multiple contact persons.","short":"The type of contact","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Organization.contact.name"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A name associated with the contact.","id":"Organization.contact.name","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-5, PID-9"},{"identity":"rim","map":"./name"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.contact.name","requirements":"Need to be able to track the person by name.","short":"A name associated with the contact","type":[{"code":"HumanName"}]},{"base":{"max":"*","min":0,"path":"Organization.contact.telecom"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.","id":"Organization.contact.telecom","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-13, PID-14"},{"identity":"rim","map":"./telecom"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.contact.telecom","requirements":"People have (primary) ways to contact them in some way such as phone, email.","short":"Contact details (telephone, email, etc.) for a contact","type":[{"code":"ContactPoint"}]},{"base":{"max":"1","min":0,"path":"Organization.contact.address"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Visiting or postal addresses for the contact.","id":"Organization.contact.address","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-11"},{"identity":"rim","map":"./addr"}],"max":"1","min":0,"mustSupport":false,"path":"Organization.contact.address","requirements":"May need to keep track of a contact party's address for contacting, billing or reporting requirements.","short":"Visiting or postal addresses for the contact","type":[{"code":"Address"}]},{"base":{"max":"*","min":0,"path":"Organization.endpoint"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Technical endpoints providing access to services operated for the organization.","id":"Organization.endpoint","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Organization.endpoint","requirements":"Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.","short":"Technical endpoints providing access to services operated for the organization","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}]}]},"status":"draft","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Organization TUDomainResourceA grouping of people or organizations with a common purpose
+ Rule: The organization SHALL at least have a name or an identifier, and possibly more than one
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
\".\"\".\"\".\" active ?!Σ0..1booleanWhether the organization's record is still in active use
\".\"\".\"\".\" type Σ0..*CodeableConceptKind of organization
OrganizationType (Example)
\".\"\".\"\".\" name ΣI0..1stringName used for the organization
\".\"\".\"\".\" alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
\".\"\".\"\".\" telecom I0..*ContactPointA contact detail for the organization
+ Rule: The telecom of an organization can never be of use 'home'
\".\"\".\"\".\" address I0..*AddressAn address for the organization
+ Rule: An address of an organization can never be of use 'home'
\".\"\".\"\".\" partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
\".\"\".\"\".\" contact 0..*BackboneElementContact for the organization for a certain purpose
\".\"\".\"\".\"\".\" purpose 0..1CodeableConceptThe type of contact
ContactEntityType (Extensible)
\".\"\".\"\".\"\".\" name 0..1HumanNameA name associated with the contact
\".\"\".\"\".\"\".\" telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
\".\"\".\"\".\"\".\" address 0..1AddressVisiting or postal addresses for the contact
\".\"\".\"\".\" endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

\"doco\" Documentation for this format
","status":"generated"},"type":"Organization","url":"http://hl7.org/fhir/StructureDefinition/Organization","version":"4.6.0"} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Organization","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Organization\n \n \n TU\n \n \n DomainResource\n A grouping of people or organizations with a common purpose\n
\n + Rule: The organization SHALL at least have a name or an identifier, and possibly more than one\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n C\n 0..*\n Identifier\n Identifies this organization across multiple systems\n
\n
\n
\n \".\"\n \".\"\n \".\" \n active\n \n \n ?!\n Σ\n 0..1\n boolean\n Whether the organization's record is still in active use\n
\n
\n \".\"\n \".\"\n \".\" \n type\n \n \n Σ\n 0..*\n CodeableConcept\n Kind of organization\n
Binding: \n Organization Type (\n Example)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n name\n \n \n Σ\n C\n 0..1\n string\n Name used for the organization\n
\n
\n \".\"\n \".\"\n \".\" \n alias\n \n \n 0..*\n string\n A list of alternate names that the organization is known as, or was known as in the past\n
\n
\n
\n \".\"\n \".\"\n \".\" \n description\n \n \n Σ\n 0..1\n markdown\n Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name\n
\n
\n \".\"\n \".\"\n \".\" \n contact\n \n \n C\n 0..*\n ExtendedContactDetail\n Official contact details for the Organization\n
\n + Rule: The telecom of an organization can never be of use 'home'\n
\n + Rule: The address of an organization can never be of use 'home'\n
\n
\n
\n \".\"\n \".\"\n \".\" \n partOf\n \n \n Σ\n 0..1\n Reference(\n Organization)\n The organization of which this organization forms a part\n
\n
\n \".\"\n \".\"\n \".\" \n endpoint\n \n \n 0..*\n Reference(\n Endpoint)\n Technical endpoints providing access to services operated for the organization\n
\n
\n
\n \".\"\n \".\"\n \".\" \n qualification\n \n \n 0..*\n BackboneElement\n Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n identifier\n \n \n 0..*\n Identifier\n An identifier for this qualification for the organization\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n code\n \n \n 1..1\n CodeableConcept\n Coded representation of the qualification\n
Binding: Qualification (\n Example)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n period\n \n \n 0..1\n Period\n Period during which the qualification is valid\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n issuer\n \n \n 0..1\n Reference(\n Organization)\n Organization that regulates and issues the qualification\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Base.Entities"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"business"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pa"}],"url":"http://hl7.org/fhir/StructureDefinition/Organization","version":"5.0.0","name":"Organization","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+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":"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"interface","uri":"http://hl7.org/fhir/interface","name":"Interface Pattern"},{"identity":"servd","uri":"http://www.omg.org/spec/ServD/1.0/","name":"ServD"}],"kind":"resource","abstract":false,"type":"Organization","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"Organization","path":"Organization","short":"A grouping of people or organizations with a common purpose","definition":"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.","min":0,"max":"*","base":{"path":"Organization","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"org-1","severity":"error","human":"The organization SHALL at least have a name or an identifier, and possibly more than one","expression":"(identifier.count() + name.count()) > 0","source":"http://hl7.org/fhir/StructureDefinition/Organization"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Organization(classCode=ORG, determinerCode=INST)"},{"identity":"w5","map":"administrative.group"},{"identity":"v2","map":"(also see master files messages)"},{"identity":"interface","map":"ParticipantContactable"},{"identity":"servd","map":"Organization"}]},{"id":"Organization.id","path":"Organization.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Organization.meta","path":"Organization.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Organization.implicitRules","path":"Organization.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Organization.language","path":"Organization.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Organization.text","path":"Organization.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Organization.contained","path":"Organization.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Organization.extension","path":"Organization.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Organization.modifierExtension","path":"Organization.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Organization.identifier","path":"Organization.identifier","short":"Identifies this organization across multiple systems","definition":"Identifier for the organization that is used to identify the organization across multiple disparate systems.","requirements":"Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.","min":0,"max":"*","base":{"path":"Organization.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"condition":["org-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"XON.10 / XON.3"},{"identity":"rim","map":".scopes[Role](classCode=IDENT)"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}]},{"id":"Organization.active","path":"Organization.active","short":"Whether the organization's record is still in active use","definition":"Whether the organization's record is still in active use.","comment":"This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.","requirements":"Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.","min":0,"max":"1","base":{"path":"Organization.active","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"v2","map":"No equivalent in HL7 V2"},{"identity":"rim","map":".status"},{"identity":"interface","map":"Participant.active"},{"identity":"servd","map":"./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."}]},{"id":"Organization.type","path":"Organization.type","short":"Kind of organization","definition":"The kind(s) of organization that this is.","comment":"Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.","requirements":"Need to be able to track the kind of organization that this is - different organization types have different uses.","min":0,"max":"*","base":{"path":"Organization.type","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"OrganizationType"}],"strength":"example","description":"Used to categorize the organization.","valueSet":"http://hl7.org/fhir/ValueSet/organization-type"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"v2","map":"No equivalent in v2"},{"identity":"rim","map":".code"},{"identity":"servd","map":"n/a"}]},{"id":"Organization.name","path":"Organization.name","short":"Name used for the organization","definition":"A name associated with the organization.","comment":"If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.","requirements":"Need to use the name as the label of the organization.","min":0,"max":"1","base":{"path":"Organization.name","min":0,"max":"1"},"type":[{"code":"string"}],"condition":["org-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XON.1"},{"identity":"rim","map":".name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":".PreferredName/Name"}]},{"id":"Organization.alias","path":"Organization.alias","short":"A list of alternate names that the organization is known as, or was known as in the past","definition":"A list of alternate names that the organization is known as, or was known as in the past.","comment":"There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.","requirements":"Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.","min":0,"max":"*","base":{"path":"Organization.alias","min":0,"max":"*"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".name"}]},{"id":"Organization.description","path":"Organization.description","short":"Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name","definition":"Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.","requirements":"Humans need additional information to verify a correct Organization has been selected.","min":0,"max":"1","base":{"path":"Organization.description","min":0,"max":"1"},"type":[{"code":"markdown"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":".playingEntity[classCode=PLC determinerCode=INSTANCE].desc"}]},{"id":"Organization.contact","path":"Organization.contact","short":"Official contact details for the Organization","definition":"The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.","comment":"The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.","requirements":"Need to keep track of assigned contact points within bigger organization.","min":0,"max":"*","base":{"path":"Organization.contact","min":0,"max":"*"},"type":[{"code":"ExtendedContactDetail"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"org-3","severity":"error","human":"The telecom of an organization can never be of use 'home'","expression":"telecom.where(use = 'home').empty()","source":"http://hl7.org/fhir/StructureDefinition/Organization"},{"key":"org-4","severity":"error","human":"The address of an organization can never be of use 'home'","expression":"address.where(use = 'home').empty()","source":"http://hl7.org/fhir/StructureDefinition/Organization"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".contactParty"}]},{"id":"Organization.partOf","path":"Organization.partOf","short":"The organization of which this organization forms a part","definition":"The organization of which this organization forms a part.","requirements":"Need to be able to track the hierarchy of organizations within an organization.","min":0,"max":"1","base":{"path":"Organization.partOf","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"No equivalent in HL7 V2"},{"identity":"rim","map":".playedBy[classCode=Part].scoper"},{"identity":"servd","map":"n/a"}]},{"id":"Organization.endpoint","path":"Organization.endpoint","short":"Technical endpoints providing access to services operated for the organization","definition":"Technical endpoints providing access to services operated for the organization.","requirements":"Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.","min":0,"max":"*","base":{"path":"Organization.endpoint","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification","path":"Organization.qualification","short":"Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care","definition":"The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.\r\rFor example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.","min":0,"max":"*","base":{"path":"Organization.qualification","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"CER?"},{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.id","path":"Organization.qualification.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.extension","path":"Organization.qualification.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.modifierExtension","path":"Organization.qualification.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Organization.qualification.identifier","path":"Organization.qualification.identifier","short":"An identifier for this qualification for the organization","definition":"An identifier allocated to this qualification for this organization.","requirements":"Often, specific identities are assigned for the qualification by the assigning organization.","min":0,"max":"*","base":{"path":"Organization.qualification.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.code","path":"Organization.qualification.code","short":"Coded representation of the qualification","definition":"Coded representation of the qualification.","min":1,"max":"1","base":{"path":"Organization.qualification.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Qualification"}],"strength":"example","description":"Specific qualification the organization has to provide a service."},"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.period","path":"Organization.qualification.period","short":"Period during which the qualification is valid","definition":"Period during which the qualification is valid.","requirements":"Qualifications are often for a limited period of time, and can be revoked.","min":0,"max":"1","base":{"path":"Organization.qualification.period","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.issuer","path":"Organization.qualification.issuer","short":"Organization that regulates and issues the qualification","definition":"Organization that regulates and issues the qualification.","min":0,"max":"1","base":{"path":"Organization.qualification.issuer","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]}]},"differential":{"element":[{"id":"Organization","path":"Organization","short":"A grouping of people or organizations with a common purpose","definition":"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.","min":0,"max":"*","constraint":[{"key":"org-1","severity":"error","human":"The organization SHALL at least have a name or an identifier, and possibly more than one","expression":"(identifier.count() + name.count()) > 0","source":"http://hl7.org/fhir/StructureDefinition/Organization"}],"mustSupport":false,"isModifier":false,"mapping":[{"identity":"w5","map":"administrative.group"},{"identity":"v2","map":"(also see master files messages)"},{"identity":"rim","map":"Organization(classCode=ORG, determinerCode=INST)"},{"identity":"interface","map":"ParticipantContactable"},{"identity":"servd","map":"Organization"}]},{"id":"Organization.identifier","path":"Organization.identifier","short":"Identifies this organization across multiple systems","definition":"Identifier for the organization that is used to identify the organization across multiple disparate systems.","requirements":"Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.","min":0,"max":"*","type":[{"code":"Identifier"}],"condition":["org-1"],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"XON.10 / XON.3"},{"identity":"rim","map":".scopes[Role](classCode=IDENT)"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}]},{"id":"Organization.active","path":"Organization.active","short":"Whether the organization's record is still in active use","definition":"Whether the organization's record is still in active use.","comment":"This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.","requirements":"Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.","min":0,"max":"1","type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"v2","map":"No equivalent in HL7 V2"},{"identity":"rim","map":".status"},{"identity":"interface","map":"Participant.active"},{"identity":"servd","map":"./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."}]},{"id":"Organization.type","path":"Organization.type","short":"Kind of organization","definition":"The kind(s) of organization that this is.","comment":"Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.","requirements":"Need to be able to track the kind of organization that this is - different organization types have different uses.","min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"OrganizationType"}],"strength":"example","description":"Used to categorize the organization.","valueSet":"http://hl7.org/fhir/ValueSet/organization-type"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"v2","map":"No equivalent in v2"},{"identity":"rim","map":".code"},{"identity":"servd","map":"n/a"}]},{"id":"Organization.name","path":"Organization.name","short":"Name used for the organization","definition":"A name associated with the organization.","comment":"If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.","requirements":"Need to use the name as the label of the organization.","min":0,"max":"1","type":[{"code":"string"}],"condition":["org-1"],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XON.1"},{"identity":"rim","map":".name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":".PreferredName/Name"}]},{"id":"Organization.alias","path":"Organization.alias","short":"A list of alternate names that the organization is known as, or was known as in the past","definition":"A list of alternate names that the organization is known as, or was known as in the past.","comment":"There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.","requirements":"Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.","min":0,"max":"*","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".name"}]},{"id":"Organization.description","path":"Organization.description","short":"Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name","definition":"Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.","requirements":"Humans need additional information to verify a correct Organization has been selected.","min":0,"max":"1","type":[{"code":"markdown"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":".playingEntity[classCode=PLC determinerCode=INSTANCE].desc"}]},{"id":"Organization.contact","path":"Organization.contact","short":"Official contact details for the Organization","definition":"The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.","comment":"The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.","requirements":"Need to keep track of assigned contact points within bigger organization.","min":0,"max":"*","type":[{"code":"ExtendedContactDetail"}],"constraint":[{"key":"org-4","severity":"error","human":"The address of an organization can never be of use 'home'","expression":"address.where(use = 'home').empty()","source":"http://hl7.org/fhir/StructureDefinition/Organization"},{"key":"org-3","severity":"error","human":"The telecom of an organization can never be of use 'home'","expression":"telecom.where(use = 'home').empty()","source":"http://hl7.org/fhir/StructureDefinition/Organization"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".contactParty"}]},{"id":"Organization.partOf","path":"Organization.partOf","short":"The organization of which this organization forms a part","definition":"The organization of which this organization forms a part.","requirements":"Need to be able to track the hierarchy of organizations within an organization.","min":0,"max":"1","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"No equivalent in HL7 V2"},{"identity":"rim","map":".playedBy[classCode=Part].scoper"},{"identity":"servd","map":"n/a"}]},{"id":"Organization.endpoint","path":"Organization.endpoint","short":"Technical endpoints providing access to services operated for the organization","definition":"Technical endpoints providing access to services operated for the organization.","requirements":"Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.","min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification","path":"Organization.qualification","short":"Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care","definition":"The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.\r\rFor example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"CER?"},{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.identifier","path":"Organization.qualification.identifier","short":"An identifier for this qualification for the organization","definition":"An identifier allocated to this qualification for this organization.","requirements":"Often, specific identities are assigned for the qualification by the assigning organization.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.code","path":"Organization.qualification.code","short":"Coded representation of the qualification","definition":"Coded representation of the qualification.","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Qualification"}],"strength":"example","description":"Specific qualification the organization has to provide a service."},"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.period","path":"Organization.qualification.period","short":"Period during which the qualification is valid","definition":"Period during which the qualification is valid.","requirements":"Qualifications are often for a limited period of time, and can be revoked.","min":0,"max":"1","type":[{"code":"Period"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Organization.qualification.issuer","path":"Organization.qualification.issuer","short":"Organization that regulates and issues the qualification","definition":"Organization that regulates and issues the qualification.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Patient.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Patient.json index 9449aea3e..e0cfac1e8 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Patient.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Patient.json @@ -1 +1 @@ -{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/pafm/index.cfm"}]}],"date":"2021-04-14T05:30:20+00:00","derivation":"specialization","description":"Demographics and other administrative information about an individual or animal receiving care or other health-related services.","differential":{"element":[{"alias":["SubjectOfCare Client Resident"],"definition":"Demographics and other administrative information about an individual or animal receiving care or other health-related services.","id":"Patient","isModifier":false,"mapping":[{"identity":"rim","map":"Patient[classCode=PAT]"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"cda","map":"ClinicalDocument.recordTarget.patientRole"},{"identity":"w5","map":"administrative.individual"}],"max":"*","min":0,"mustSupport":false,"path":"Patient","short":"Information about an individual or animal receiving health care services"},{"definition":"An identifier for this patient.","id":"Patient.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"cda","map":".id"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.identifier","requirements":"Patients are almost always assigned specific numerical identifiers.","short":"An identifier for this patient","type":[{"code":"Identifier"}]},{"comment":"If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.","definition":"Whether this patient record is in active use. \nMany 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.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.","id":"Patient.active","isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"statusCode"},{"identity":"interface","map":"Participant.active"},{"identity":"cda","map":"n/a"}],"max":"1","meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","min":0,"mustSupport":false,"path":"Patient.active","requirements":"Need to be able to mark a patient record as not to be used because it was created in error.","short":"Whether this patient's record is in active use","type":[{"code":"boolean"}]},{"comment":"A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.","definition":"A name associated with the individual.","id":"Patient.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-5, PID-9"},{"identity":"rim","map":"name"},{"identity":"interface","map":"Participant.name"},{"identity":"cda","map":".patient.name"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.name","requirements":"Need to be able to track the patient by multiple names. Examples are your official name and a partner name.","short":"A name associated with the patient","type":[{"code":"HumanName"}]},{"comment":"A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).","definition":"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.","id":"Patient.telecom","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-13, PID-14, PID-40"},{"identity":"rim","map":"telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"cda","map":".telecom"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.telecom","requirements":"People have (primary) ways to contact them in some way such as phone, email.","short":"A contact detail for the individual","type":[{"code":"ContactPoint"}]},{"binding":{"description":"The gender of a person used for administrative purposes.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|4.6.0|4.6.0"},"comment":"The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.","definition":"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.","id":"Patient.gender","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-8"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"cda","map":".patient.administrativeGenderCode"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.gender","requirements":"Needed for identification of the individual, in combination with (at least) name and birth date.","short":"male | female | other | unknown","type":[{"code":"code"}]},{"comment":"At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).","definition":"The date of birth for the individual.","id":"Patient.birthDate","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-7"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"cda","map":".patient.birthTime"},{"identity":"loinc","map":"21112-8"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.birthDate","requirements":"Age of the individual drives many clinical processes.","short":"The date of birth for the individual","type":[{"code":"date"}]},{"comment":"If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.","definition":"Indicates if the individual is deceased or not.","id":"Patient.deceased[x]","isModifier":true,"isModifierReason":"This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.","isSummary":true,"mapping":[{"identity":"v2","map":"PID-30 (bool) and PID-29 (datetime)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.deceased[x]","requirements":"The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.","short":"Indicates if the individual is deceased or not","type":[{"code":"boolean"},{"code":"dateTime"}]},{"comment":"Patient may have multiple addresses with different uses or applicable periods.","definition":"An address for the individual.","id":"Patient.address","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-11"},{"identity":"rim","map":"addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"cda","map":".addr"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.address","requirements":"May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.","short":"An address for the individual","type":[{"code":"Address"}]},{"binding":{"description":"The domestic partnership status of a person.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MaritalStatus"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/marital-status"},"definition":"This field contains a patient's most recent marital (civil) status.","id":"Patient.maritalStatus","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-16"},{"identity":"rim","map":"player[classCode=PSN]/maritalStatusCode"},{"identity":"cda","map":".patient.maritalStatusCode"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.maritalStatus","requirements":"Most, if not all systems capture it.","short":"Marital (civil) status of a patient","type":[{"code":"CodeableConcept"}]},{"comment":"Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).","definition":"Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).","id":"Patient.multipleBirth[x]","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-24 (bool), PID-25 (integer)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.multipleBirth[x]","requirements":"For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.","short":"Whether patient is part of a multiple birth","type":[{"code":"boolean"},{"code":"integer"}]},{"comment":"Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.","definition":"Image of the patient.","id":"Patient.photo","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 - needs a profile"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.photo","requirements":"Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.","short":"Image of the patient","type":[{"code":"Attachment"}]},{"comment":"Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.","constraint":[{"expression":"name.exists() or telecom.exists() or address.exists() or organization.exists()","human":"SHALL at least contain a contact's details or a reference to an organization","key":"pat-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Patient","xpath":"exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)"}],"definition":"A contact party (e.g. guardian, partner, friend) for the patient.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"Contact"}],"id":"Patient.contact","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.contact","requirements":"Need to track people you can contact about the patient.","short":"A contact party (e.g. guardian, partner, friend) for the patient","type":[{"code":"BackboneElement"}]},{"binding":{"description":"The nature of the relationship between a patient and a contact person for that patient.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ContactRelationship"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/patient-contactrelationship"},"definition":"The nature of the relationship between the patient and the contact person.","id":"Patient.contact.relationship","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-7, NK1-3"},{"identity":"rim","map":"code"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.contact.relationship","requirements":"Used to determine which contact person is the most relevant to approach, depending on circumstances.","short":"The kind of relationship","type":[{"code":"CodeableConcept"}]},{"definition":"A name associated with the contact person.","id":"Patient.contact.name","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-2"},{"identity":"rim","map":"name"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.name","requirements":"Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.","short":"A name associated with the contact person","type":[{"code":"HumanName"}]},{"comment":"Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.","definition":"A contact detail for the person, e.g. a telephone number or an email address.","id":"Patient.contact.telecom","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-5, NK1-6, NK1-40"},{"identity":"rim","map":"telecom"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.contact.telecom","requirements":"People have (primary) ways to contact them in some way such as phone, email.","short":"A contact detail for the person","type":[{"code":"ContactPoint"}]},{"definition":"Address for the contact person.","id":"Patient.contact.address","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-4"},{"identity":"rim","map":"addr"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.address","requirements":"Need to keep track where the contact person can be contacted per postal mail or visited.","short":"Address for the contact person","type":[{"code":"Address"}]},{"binding":{"description":"The gender of a person used for administrative purposes.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|4.6.0|4.6.0"},"definition":"Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.","id":"Patient.contact.gender","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-15"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.gender","requirements":"Needed to address the person correctly.","short":"male | female | other | unknown","type":[{"code":"code"}]},{"condition":["pat-1"],"definition":"Organization on behalf of which the contact is acting or for which the contact is working.","id":"Patient.contact.organization","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"},{"identity":"rim","map":"scoper"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.organization","requirements":"For guardians or business related contacts, the organization is relevant.","short":"Organization that is associated with the contact","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"definition":"The period during which this contact person or organization is valid to be contacted relating to this patient.","id":"Patient.contact.period","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"effectiveTime"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.period","short":"The period during which this contact person or organization is valid to be contacted relating to this patient","type":[{"code":"Period"}]},{"comment":"If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.","definition":"A language which may be used to communicate with the patient about his or her health.","id":"Patient.communication","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"LanguageCommunication"},{"identity":"interface","map":"ParticipantLiving.communication"},{"identity":"cda","map":"patient.languageCommunication"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.communication","requirements":"If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.","short":"A language which may be used to communicate with the patient about his or her health","type":[{"code":"BackboneElement"}]},{"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","definition":"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.","id":"Patient.communication.language","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15, LAN-2"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"},{"identity":"cda","map":".languageCode"}],"max":"1","min":1,"mustSupport":false,"path":"Patient.communication.language","requirements":"Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.","short":"The language which can be used to communicate with the patient about his or her health","type":[{"code":"CodeableConcept"}]},{"comment":"This language is specifically identified for communicating healthcare information.","definition":"Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).","id":"Patient.communication.preferred","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15"},{"identity":"rim","map":"preferenceInd"},{"identity":"cda","map":".preferenceInd"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.communication.preferred","requirements":"People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.","short":"Language preference indicator","type":[{"code":"boolean"}]},{"alias":["careProvider"],"comment":"This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.","definition":"Patient's nominated care provider.","id":"Patient.generalPractitioner","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PD1-4"},{"identity":"rim","map":"subjectOf.CareEvent.performer.AssignedEntity"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.generalPractitioner","short":"Patient's nominated primary care provider","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}]},{"comment":"There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).","definition":"Organization that is the custodian of the patient record.","id":"Patient.managingOrganization","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"scoper"},{"identity":"cda","map":".providerOrganization"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.managingOrganization","requirements":"Need to know who recognizes this patient record, manages and updates it.","short":"Organization that is the custodian of the patient record","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"comment":"There is no assumption that linked patient records have mutual links.","definition":"Link to another patient resource that concerns the same actual patient.","id":"Patient.link","isModifier":true,"isModifierReason":"This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'","isSummary":true,"mapping":[{"identity":"rim","map":"outboundLink"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.link","requirements":"There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.","short":"Link to another patient resource that concerns the same actual person","type":[{"code":"BackboneElement"}]},{"comment":"Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.","definition":"The other patient resource that the link refers to.","id":"Patient.link.other","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-3, MRG-1"},{"identity":"rim","map":"id"},{"identity":"cda","map":"n/a"}],"max":"1","min":1,"mustSupport":false,"path":"Patient.link.other","short":"The other patient or related person resource that the link refers to","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}]},{"binding":{"description":"The type of link between this patient resource and another patient resource.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"LinkType"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/link-type|4.6.0|4.6.0"},"definition":"The type of link between this patient resource and another patient resource.","id":"Patient.link.type","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"typeCode"},{"identity":"cda","map":"n/a"}],"max":"1","min":1,"mustSupport":false,"path":"Patient.link.type","short":"replaced-by | replaces | refer | seealso","type":[{"code":"code"}]}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pa"}],"fhirVersion":"4.6.0","id":"Patient","kind":"resource","mapping":[{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"interface","name":"Interface Pattern","uri":"http://hl7.org/fhir/interface"},{"identity":"cda","name":"CDA (R2)","uri":"http://hl7.org/v3/cda"},{"identity":"w5","name":"FiveWs Pattern Mapping","uri":"http://hl7.org/fhir/fivews"},{"identity":"v2","name":"HL7 v2 Mapping","uri":"http://hl7.org/v2"},{"identity":"loinc","name":"LOINC code for the element","uri":"http://loinc.org"}],"meta":{"lastUpdated":"2021-04-14T05:30:20.096+00:00"},"name":"Patient","publisher":"Health Level Seven International (Patient Administration)","purpose":"Tracking patient is the center of the healthcare process.","resourceType":"StructureDefinition","snapshot":{"element":[{"alias":["SubjectOfCare Client Resident"],"base":{"max":"*","min":0,"path":"Patient"},"constraint":[{"expression":"contained.contained.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","key":"dom-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(parent::f:contained and f:contained)"},{"expression":"contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","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","key":"dom-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"},{"expression":"contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated","key":"dom-4","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"},{"expression":"contained.meta.security.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a security label","key":"dom-5","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:security))"},{"expression":"text.`div`.exists()","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"human":"A resource should have narrative for robust management","key":"dom-6","severity":"warning","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"exists(f:text/h:div)"}],"definition":"Demographics and other administrative information about an individual or animal receiving care or other health-related services.","id":"Patient","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act"},{"identity":"rim","map":"Patient[classCode=PAT]"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"cda","map":"ClinicalDocument.recordTarget.patientRole"},{"identity":"w5","map":"administrative.individual"}],"max":"*","min":0,"mustSupport":false,"path":"Patient","short":"Information about an individual or animal receiving health care services"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"Typically, the resource has an id except for cases like the create operation, conditional updates.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Patient.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Patient.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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.","id":"Patient.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Patient.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","id":"Patient.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Patient.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The base language in which the resource is written.","id":"Patient.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"Patient.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"Contained resources do not have a 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 information is added later.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Patient.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.","definition":"These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.","id":"Patient.contained","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"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.","id":"Patient.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Patient.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"base":{"max":"*","min":0,"path":"Patient.identifier"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"An identifier for this patient.","id":"Patient.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"cda","map":".id"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.identifier","requirements":"Patients are almost always assigned specific numerical identifiers.","short":"An identifier for this patient","type":[{"code":"Identifier"}]},{"base":{"max":"1","min":0,"path":"Patient.active"},"comment":"If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Whether this patient record is in active use. \nMany 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.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.","id":"Patient.active","isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"statusCode"},{"identity":"interface","map":"Participant.active"},{"identity":"cda","map":"n/a"}],"max":"1","meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","min":0,"mustSupport":false,"path":"Patient.active","requirements":"Need to be able to mark a patient record as not to be used because it was created in error.","short":"Whether this patient's record is in active use","type":[{"code":"boolean"}]},{"base":{"max":"*","min":0,"path":"Patient.name"},"comment":"A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A name associated with the individual.","id":"Patient.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-5, PID-9"},{"identity":"rim","map":"name"},{"identity":"interface","map":"Participant.name"},{"identity":"cda","map":".patient.name"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.name","requirements":"Need to be able to track the patient by multiple names. Examples are your official name and a partner name.","short":"A name associated with the patient","type":[{"code":"HumanName"}]},{"base":{"max":"*","min":0,"path":"Patient.telecom"},"comment":"A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.","id":"Patient.telecom","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-13, PID-14, PID-40"},{"identity":"rim","map":"telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"cda","map":".telecom"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.telecom","requirements":"People have (primary) ways to contact them in some way such as phone, email.","short":"A contact detail for the individual","type":[{"code":"ContactPoint"}]},{"base":{"max":"1","min":0,"path":"Patient.gender"},"binding":{"description":"The gender of a person used for administrative purposes.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|4.6.0|4.6.0"},"comment":"The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.","id":"Patient.gender","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-8"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"cda","map":".patient.administrativeGenderCode"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.gender","requirements":"Needed for identification of the individual, in combination with (at least) name and birth date.","short":"male | female | other | unknown","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"Patient.birthDate"},"comment":"At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The date of birth for the individual.","id":"Patient.birthDate","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-7"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"cda","map":".patient.birthTime"},{"identity":"loinc","map":"21112-8"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.birthDate","requirements":"Age of the individual drives many clinical processes.","short":"The date of birth for the individual","type":[{"code":"date"}]},{"base":{"max":"1","min":0,"path":"Patient.deceased[x]"},"comment":"If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Indicates if the individual is deceased or not.","id":"Patient.deceased[x]","isModifier":true,"isModifierReason":"This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.","isSummary":true,"mapping":[{"identity":"v2","map":"PID-30 (bool) and PID-29 (datetime)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.deceased[x]","requirements":"The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.","short":"Indicates if the individual is deceased or not","type":[{"code":"boolean"},{"code":"dateTime"}]},{"base":{"max":"*","min":0,"path":"Patient.address"},"comment":"Patient may have multiple addresses with different uses or applicable periods.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"An address for the individual.","id":"Patient.address","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-11"},{"identity":"rim","map":"addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"cda","map":".addr"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.address","requirements":"May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.","short":"An address for the individual","type":[{"code":"Address"}]},{"base":{"max":"1","min":0,"path":"Patient.maritalStatus"},"binding":{"description":"The domestic partnership status of a person.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MaritalStatus"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/marital-status"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"This field contains a patient's most recent marital (civil) status.","id":"Patient.maritalStatus","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-16"},{"identity":"rim","map":"player[classCode=PSN]/maritalStatusCode"},{"identity":"cda","map":".patient.maritalStatusCode"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.maritalStatus","requirements":"Most, if not all systems capture it.","short":"Marital (civil) status of a patient","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Patient.multipleBirth[x]"},"comment":"Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).","id":"Patient.multipleBirth[x]","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-24 (bool), PID-25 (integer)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.multipleBirth[x]","requirements":"For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.","short":"Whether patient is part of a multiple birth","type":[{"code":"boolean"},{"code":"integer"}]},{"base":{"max":"*","min":0,"path":"Patient.photo"},"comment":"Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Image of the patient.","id":"Patient.photo","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 - needs a profile"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.photo","requirements":"Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.","short":"Image of the patient","type":[{"code":"Attachment"}]},{"base":{"max":"*","min":0,"path":"Patient.contact"},"comment":"Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"name.exists() or telecom.exists() or address.exists() or organization.exists()","human":"SHALL at least contain a contact's details or a reference to an organization","key":"pat-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Patient","xpath":"exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)"}],"definition":"A contact party (e.g. guardian, partner, friend) for the patient.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"Contact"}],"id":"Patient.contact","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.contact","requirements":"Need to track people you can contact about the patient.","short":"A contact party (e.g. guardian, partner, friend) for the patient","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Patient.contact.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Patient.contact.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"Patient.contact.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Patient.contact.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Patient.contact.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Patient.contact.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"*","min":0,"path":"Patient.contact.relationship"},"binding":{"description":"The nature of the relationship between a patient and a contact person for that patient.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ContactRelationship"}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/patient-contactrelationship"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The nature of the relationship between the patient and the contact person.","id":"Patient.contact.relationship","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-7, NK1-3"},{"identity":"rim","map":"code"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.contact.relationship","requirements":"Used to determine which contact person is the most relevant to approach, depending on circumstances.","short":"The kind of relationship","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Patient.contact.name"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A name associated with the contact person.","id":"Patient.contact.name","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-2"},{"identity":"rim","map":"name"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.name","requirements":"Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.","short":"A name associated with the contact person","type":[{"code":"HumanName"}]},{"base":{"max":"*","min":0,"path":"Patient.contact.telecom"},"comment":"Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A contact detail for the person, e.g. a telephone number or an email address.","id":"Patient.contact.telecom","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-5, NK1-6, NK1-40"},{"identity":"rim","map":"telecom"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.contact.telecom","requirements":"People have (primary) ways to contact them in some way such as phone, email.","short":"A contact detail for the person","type":[{"code":"ContactPoint"}]},{"base":{"max":"1","min":0,"path":"Patient.contact.address"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Address for the contact person.","id":"Patient.contact.address","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-4"},{"identity":"rim","map":"addr"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.address","requirements":"Need to keep track where the contact person can be contacted per postal mail or visited.","short":"Address for the contact person","type":[{"code":"Address"}]},{"base":{"max":"1","min":0,"path":"Patient.contact.gender"},"binding":{"description":"The gender of a person used for administrative purposes.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|4.6.0|4.6.0"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.","id":"Patient.contact.gender","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-15"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.gender","requirements":"Needed to address the person correctly.","short":"male | female | other | unknown","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"Patient.contact.organization"},"condition":["pat-1"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Organization on behalf of which the contact is acting or for which the contact is working.","id":"Patient.contact.organization","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"},{"identity":"rim","map":"scoper"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.organization","requirements":"For guardians or business related contacts, the organization is relevant.","short":"Organization that is associated with the contact","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"base":{"max":"1","min":0,"path":"Patient.contact.period"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The period during which this contact person or organization is valid to be contacted relating to this patient.","id":"Patient.contact.period","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"effectiveTime"},{"identity":"cda","map":"n/a"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.contact.period","short":"The period during which this contact person or organization is valid to be contacted relating to this patient","type":[{"code":"Period"}]},{"base":{"max":"*","min":0,"path":"Patient.communication"},"comment":"If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A language which may be used to communicate with the patient about his or her health.","id":"Patient.communication","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"LanguageCommunication"},{"identity":"interface","map":"ParticipantLiving.communication"},{"identity":"cda","map":"patient.languageCommunication"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.communication","requirements":"If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.","short":"A language which may be used to communicate with the patient about his or her health","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Patient.communication.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Patient.communication.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"Patient.communication.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Patient.communication.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Patient.communication.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Patient.communication.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"Patient.communication.language"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Patient.communication.language","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15, LAN-2"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"},{"identity":"cda","map":".languageCode"}],"max":"1","min":1,"mustSupport":false,"path":"Patient.communication.language","requirements":"Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.","short":"The language which can be used to communicate with the patient about his or her health","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Patient.communication.preferred"},"comment":"This language is specifically identified for communicating healthcare information.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).","id":"Patient.communication.preferred","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15"},{"identity":"rim","map":"preferenceInd"},{"identity":"cda","map":".preferenceInd"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.communication.preferred","requirements":"People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.","short":"Language preference indicator","type":[{"code":"boolean"}]},{"alias":["careProvider"],"base":{"max":"*","min":0,"path":"Patient.generalPractitioner"},"comment":"This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Patient's nominated care provider.","id":"Patient.generalPractitioner","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PD1-4"},{"identity":"rim","map":"subjectOf.CareEvent.performer.AssignedEntity"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.generalPractitioner","short":"Patient's nominated primary care provider","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}]},{"base":{"max":"1","min":0,"path":"Patient.managingOrganization"},"comment":"There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Organization that is the custodian of the patient record.","id":"Patient.managingOrganization","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"scoper"},{"identity":"cda","map":".providerOrganization"}],"max":"1","min":0,"mustSupport":false,"path":"Patient.managingOrganization","requirements":"Need to know who recognizes this patient record, manages and updates it.","short":"Organization that is the custodian of the patient record","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"base":{"max":"*","min":0,"path":"Patient.link"},"comment":"There is no assumption that linked patient records have mutual links.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Link to another patient resource that concerns the same actual patient.","id":"Patient.link","isModifier":true,"isModifierReason":"This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'","isSummary":true,"mapping":[{"identity":"rim","map":"outboundLink"},{"identity":"cda","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Patient.link","requirements":"There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.","short":"Link to another patient resource that concerns the same actual person","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Patient.link.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Patient.link.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"Patient.link.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Patient.link.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Patient.link.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Patient.link.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"Patient.link.other"},"comment":"Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The other patient resource that the link refers to.","id":"Patient.link.other","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-3, MRG-1"},{"identity":"rim","map":"id"},{"identity":"cda","map":"n/a"}],"max":"1","min":1,"mustSupport":false,"path":"Patient.link.other","short":"The other patient or related person resource that the link refers to","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}]},{"base":{"max":"1","min":1,"path":"Patient.link.type"},"binding":{"description":"The type of link between this patient resource and another patient resource.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"LinkType"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/link-type|4.6.0|4.6.0"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The type of link between this patient resource and another patient resource.","id":"Patient.link.type","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"typeCode"},{"identity":"cda","map":"n/a"}],"max":"1","min":1,"mustSupport":false,"path":"Patient.link.type","short":"replaced-by | replaces | refer | seealso","type":[{"code":"code"}]}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Patient NDomainResourceInformation about an individual or animal receiving health care services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier Σ0..*IdentifierAn identifier for this patient
\".\"\".\"\".\" active ?!Σ0..1booleanWhether this patient's record is in active use
\".\"\".\"\".\" name Σ0..*HumanNameA name associated with the patient
\".\"\".\"\".\" telecom Σ0..*ContactPointA contact detail for the individual
\".\"\".\"\".\" gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
\".\"\".\"\".\" birthDate Σ0..1dateThe date of birth for the individual
\".\"\".\"\".\" deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
\".\"\".\"\".\"\".\" deceasedBooleanboolean
\".\"\".\"\".\"\".\" deceasedDateTimedateTime
\".\"\".\"\".\" address Σ0..*AddressAn address for the individual
\".\"\".\"\".\" maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
MaritalStatus (Extensible)
\".\"\".\"\".\" multipleBirth[x] 0..1Whether patient is part of a multiple birth
\".\"\".\"\".\"\".\" multipleBirthBooleanboolean
\".\"\".\"\".\"\".\" multipleBirthIntegerinteger
\".\"\".\"\".\" photo 0..*AttachmentImage of the patient
\".\"\".\"\".\" contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
+ Rule: SHALL at least contain a contact's details or a reference to an organization
\".\"\".\"\".\"\".\" relationship 0..*CodeableConceptThe kind of relationship
Patient Contact Relationship (Extensible)
\".\"\".\"\".\"\".\" name 0..1HumanNameA name associated with the contact person
\".\"\".\"\".\"\".\" telecom 0..*ContactPointA contact detail for the person
\".\"\".\"\".\"\".\" address 0..1AddressAddress for the contact person
\".\"\".\"\".\"\".\" gender 0..1codemale | female | other | unknown
AdministrativeGender (Required)
\".\"\".\"\".\"\".\" organization I0..1Reference(Organization)Organization that is associated with the contact
\".\"\".\"\".\"\".\" period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
\".\"\".\"\".\" communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
\".\"\".\"\".\"\".\" language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Common Languages (Preferred but limited to AllLanguages)
\".\"\".\"\".\"\".\" preferred 0..1booleanLanguage preference indicator
\".\"\".\"\".\" generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
\".\"\".\"\".\" managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
\".\"\".\"\".\" link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
\".\"\".\"\".\"\".\" other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
\".\"\".\"\".\"\".\" type Σ1..1codereplaced-by | replaces | refer | seealso
LinkType (Required)

\"doco\" Documentation for this format
","status":"generated"},"type":"Patient","url":"http://hl7.org/fhir/StructureDefinition/Patient","version":"4.6.0"} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Patient","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Patient\n \n \n N\n \n \n DomainResource\n Information about an individual or animal receiving health care services\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n 0..*\n Identifier\n An identifier for this patient\n
\n
\n
\n \".\"\n \".\"\n \".\" \n active\n \n \n ?!\n Σ\n 0..1\n boolean\n Whether this patient's record is in active use\n
\n
\n \".\"\n \".\"\n \".\" \n name\n \n \n Σ\n 0..*\n HumanName\n A name associated with the patient\n
\n
\n
\n \".\"\n \".\"\n \".\" \n telecom\n \n \n Σ\n 0..*\n ContactPoint\n A contact detail for the individual\n
\n
\n
\n \".\"\n \".\"\n \".\" \n gender\n \n \n Σ\n 0..1\n code\n male | female | other | unknown\n
Binding: \n AdministrativeGender (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n birthDate\n \n \n Σ\n 0..1\n date\n The date of birth for the individual\n
\n
\n \".\"\n \".\"\n \".\" \n deceased[x]\n \n \n ?!\n Σ\n 0..1\n Indicates if the individual is deceased or not\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n deceasedBoolean\n \n \n \n boolean\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n deceasedDateTime\n \n \n \n dateTime\n \n
\n \".\"\n \".\"\n \".\" \n address\n \n \n Σ\n 0..*\n Address\n An address for the individual\n
\n
\n
\n \".\"\n \".\"\n \".\" \n maritalStatus\n \n \n 0..1\n CodeableConcept\n Marital (civil) status of a patient\n
Binding: \n Marital Status Codes (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\" \n multipleBirth[x]\n \n \n 0..1\n Whether patient is part of a multiple birth\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n multipleBirthBoolean\n \n \n \n boolean\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n multipleBirthInteger\n \n \n \n integer\n \n
\n \".\"\n \".\"\n \".\" \n photo\n \n \n 0..*\n Attachment\n Image of the patient\n
\n
\n
\n \".\"\n \".\"\n \".\" \n contact\n \n \n C\n 0..*\n BackboneElement\n A contact party (e.g. guardian, partner, friend) for the patient\n
\n + Rule: SHALL at least contain a contact's details or a reference to an organization\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n relationship\n \n \n 0..*\n CodeableConcept\n The kind of relationship\n
Binding: \n Patient Contact Relationship (\n Extensible)\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n name\n \n \n C\n 0..1\n HumanName\n A name associated with the contact person\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n telecom\n \n \n C\n 0..*\n ContactPoint\n A contact detail for the person\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n address\n \n \n C\n 0..1\n Address\n Address for the contact person\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n gender\n \n \n 0..1\n code\n male | female | other | unknown\n
Binding: \n AdministrativeGender (\n Required)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n organization\n \n \n C\n 0..1\n Reference(\n Organization)\n Organization that is associated with the contact\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n period\n \n \n 0..1\n Period\n The period during which this contact person or organization is valid to be contacted relating to this patient\n
\n
\n \".\"\n \".\"\n \".\" \n communication\n \n \n 0..*\n BackboneElement\n A language which may be used to communicate with the patient about his or her health\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n language\n \n \n 1..1\n CodeableConcept\n The language which can be used to communicate with the patient about his or her health\n
Binding: \n All Languages (\n Required)\n \n \n \n \n \n \n \n \n \n
\n Additional Bindings\n Purpose
\n Common Languages\n \n Starter Set\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n preferred\n \n \n 0..1\n boolean\n Language preference indicator\n
\n
\n \".\"\n \".\"\n \".\" \n generalPractitioner\n \n \n 0..*\n Reference(\n Organization | \n Practitioner | \n PractitionerRole)\n Patient's nominated primary care provider\n
\n
\n
\n \".\"\n \".\"\n \".\" \n managingOrganization\n \n \n Σ\n 0..1\n Reference(\n Organization)\n Organization that is the custodian of the patient record\n
\n
\n \".\"\n \".\"\n \".\" \n link\n \n \n ?!\n Σ\n 0..*\n BackboneElement\n Link to a Patient or RelatedPerson resource that concerns the same actual individual\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n other\n \n \n Σ\n 1..1\n Reference(\n Patient | \n RelatedPerson)\n The other patient or related person resource that the link refers to\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n type\n \n \n Σ\n 1..1\n code\n replaced-by | replaces | refer | seealso\n
Binding: \n Link Type (\n Required)\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Base.Individuals"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pa"}],"url":"http://hl7.org/fhir/StructureDefinition/Patient","version":"5.0.0","name":"Patient","status":"active","experimental":false,"date":"2023-03-26T15:21:02+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":"Demographics and other administrative information about an individual or animal receiving care or other health-related services.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"purpose":"Tracking patient is the center of the healthcare process.","fhirVersion":"5.0.0","mapping":[{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"interface","uri":"http://hl7.org/fhir/interface","name":"Interface Pattern"},{"identity":"cda","uri":"http://hl7.org/v3/cda","name":"CDA (R2)"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"loinc","uri":"http://loinc.org","name":"LOINC code for the element"}],"kind":"resource","abstract":false,"type":"Patient","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"Patient","path":"Patient","short":"Information about an individual or animal receiving health care services","definition":"Demographics and other administrative information about an individual or animal receiving care or other health-related services.","alias":["SubjectOfCare Client Resident"],"min":0,"max":"*","base":{"path":"Patient","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Patient[classCode=PAT]"},{"identity":"w5","map":"administrative.individual"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"cda","map":"ClinicalDocument.recordTarget.patientRole"}]},{"id":"Patient.id","path":"Patient.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Patient.meta","path":"Patient.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Patient.implicitRules","path":"Patient.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Patient.language","path":"Patient.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Patient.text","path":"Patient.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Patient.contained","path":"Patient.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Patient.extension","path":"Patient.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Patient.modifierExtension","path":"Patient.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Patient.identifier","path":"Patient.identifier","short":"An identifier for this patient","definition":"An identifier for this patient.","requirements":"Patients are almost always assigned specific numerical identifiers.","min":0,"max":"*","base":{"path":"Patient.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"cda","map":".id"}]},{"id":"Patient.active","path":"Patient.active","short":"Whether this patient's record is in active use","definition":"Whether this patient record is in active use. \nMany 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.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.","comment":"If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.","requirements":"Need to be able to mark a patient record as not to be used because it was created in error.","min":0,"max":"1","base":{"path":"Patient.active","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"statusCode"},{"identity":"interface","map":"Participant.active"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.name","path":"Patient.name","short":"A name associated with the patient","definition":"A name associated with the individual.","comment":"A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.","requirements":"Need to be able to track the patient by multiple names. Examples are your official name and a partner name.","min":0,"max":"*","base":{"path":"Patient.name","min":0,"max":"*"},"type":[{"code":"HumanName"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-5, PID-9"},{"identity":"rim","map":"name"},{"identity":"interface","map":"Participant.name"},{"identity":"cda","map":".patient.name"}]},{"id":"Patient.telecom","path":"Patient.telecom","short":"A contact detail for the individual","definition":"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.","comment":"A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).","requirements":"People have (primary) ways to contact them in some way such as phone, email.","min":0,"max":"*","base":{"path":"Patient.telecom","min":0,"max":"*"},"type":[{"code":"ContactPoint"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-13, PID-14, PID-40"},{"identity":"rim","map":"telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"cda","map":".telecom"}]},{"id":"Patient.gender","path":"Patient.gender","short":"male | female | other | unknown","definition":"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.","comment":"The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.","requirements":"Needed for identification of the individual, in combination with (at least) name and birth date.","min":0,"max":"1","base":{"path":"Patient.gender","min":0,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The gender of a person used for administrative purposes.","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0"},"mapping":[{"identity":"v2","map":"PID-8"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"cda","map":".patient.administrativeGenderCode"}]},{"id":"Patient.birthDate","path":"Patient.birthDate","short":"The date of birth for the individual","definition":"The date of birth for the individual.","comment":"Partial dates are allowed if the specific date of birth is unknown. There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).","requirements":"Age of the individual drives many clinical processes.","min":0,"max":"1","base":{"path":"Patient.birthDate","min":0,"max":"1"},"type":[{"code":"date"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-7"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"cda","map":".patient.birthTime"},{"identity":"loinc","map":"21112-8"}]},{"id":"Patient.deceased[x]","path":"Patient.deceased[x]","short":"Indicates if the individual is deceased or not","definition":"Indicates if the individual is deceased or not.","comment":"If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.","requirements":"The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.","min":0,"max":"1","base":{"path":"Patient.deceased[x]","min":0,"max":"1"},"type":[{"code":"boolean"},{"code":"dateTime"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.","isSummary":true,"mapping":[{"identity":"v2","map":"PID-30 (bool) and PID-29 (datetime)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.address","path":"Patient.address","short":"An address for the individual","definition":"An address for the individual.","comment":"Patient may have multiple addresses with different uses or applicable periods.","requirements":"May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.","min":0,"max":"*","base":{"path":"Patient.address","min":0,"max":"*"},"type":[{"code":"Address"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-11"},{"identity":"rim","map":"addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"cda","map":".addr"}]},{"id":"Patient.maritalStatus","path":"Patient.maritalStatus","short":"Marital (civil) status of a patient","definition":"This field contains a patient's most recent marital (civil) status.","requirements":"Most, if not all systems capture it.","min":0,"max":"1","base":{"path":"Patient.maritalStatus","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MaritalStatus"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"The domestic partnership status of a person.","valueSet":"http://hl7.org/fhir/ValueSet/marital-status"},"mapping":[{"identity":"v2","map":"PID-16"},{"identity":"rim","map":"player[classCode=PSN]/maritalStatusCode"},{"identity":"cda","map":".patient.maritalStatusCode"}]},{"id":"Patient.multipleBirth[x]","path":"Patient.multipleBirth[x]","short":"Whether patient is part of a multiple birth","definition":"Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).","comment":"Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).","requirements":"For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.","min":0,"max":"1","base":{"path":"Patient.multipleBirth[x]","min":0,"max":"1"},"type":[{"code":"boolean"},{"code":"integer"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-24 (bool), PID-25 (integer)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.photo","path":"Patient.photo","short":"Image of the patient","definition":"Image of the patient.","comment":"Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.","requirements":"Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.","min":0,"max":"*","base":{"path":"Patient.photo","min":0,"max":"*"},"type":[{"code":"Attachment"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 - needs a profile"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"Contact"}],"path":"Patient.contact","short":"A contact party (e.g. guardian, partner, friend) for the patient","definition":"A contact party (e.g. guardian, partner, friend) for the patient.","comment":"Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.","requirements":"Need to track people you can contact about the patient.","min":0,"max":"*","base":{"path":"Patient.contact","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"pat-1","severity":"error","human":"SHALL at least contain a contact's details or a reference to an organization","expression":"name.exists() or telecom.exists() or address.exists() or organization.exists()","source":"http://hl7.org/fhir/StructureDefinition/Patient"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.id","path":"Patient.contact.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Patient.contact.extension","path":"Patient.contact.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Patient.contact.modifierExtension","path":"Patient.contact.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Patient.contact.relationship","path":"Patient.contact.relationship","short":"The kind of relationship","definition":"The nature of the relationship between the patient and the contact person.","requirements":"Used to determine which contact person is the most relevant to approach, depending on circumstances.","min":0,"max":"*","base":{"path":"Patient.contact.relationship","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ContactRelationship"}],"strength":"extensible","description":"The nature of the relationship between a patient and a contact person for that patient.","valueSet":"http://hl7.org/fhir/ValueSet/patient-contactrelationship"},"mapping":[{"identity":"v2","map":"NK1-7, NK1-3"},{"identity":"rim","map":"code"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.name","path":"Patient.contact.name","short":"A name associated with the contact person","definition":"A name associated with the contact person.","requirements":"Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.","min":0,"max":"1","base":{"path":"Patient.contact.name","min":0,"max":"1"},"type":[{"code":"HumanName"}],"condition":["pat-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-2"},{"identity":"rim","map":"name"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.telecom","path":"Patient.contact.telecom","short":"A contact detail for the person","definition":"A contact detail for the person, e.g. a telephone number or an email address.","comment":"Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.","requirements":"People have (primary) ways to contact them in some way such as phone, email.","min":0,"max":"*","base":{"path":"Patient.contact.telecom","min":0,"max":"*"},"type":[{"code":"ContactPoint"}],"condition":["pat-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-5, NK1-6, NK1-40"},{"identity":"rim","map":"telecom"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.address","path":"Patient.contact.address","short":"Address for the contact person","definition":"Address for the contact person.","requirements":"Need to keep track where the contact person can be contacted per postal mail or visited.","min":0,"max":"1","base":{"path":"Patient.contact.address","min":0,"max":"1"},"type":[{"code":"Address"}],"condition":["pat-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-4"},{"identity":"rim","map":"addr"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.gender","path":"Patient.contact.gender","short":"male | female | other | unknown","definition":"Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.","requirements":"Needed to address the person correctly.","min":0,"max":"1","base":{"path":"Patient.contact.gender","min":0,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The gender of a person used for administrative purposes.","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0"},"mapping":[{"identity":"v2","map":"NK1-15"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.organization","path":"Patient.contact.organization","short":"Organization that is associated with the contact","definition":"Organization on behalf of which the contact is acting or for which the contact is working.","requirements":"For guardians or business related contacts, the organization is relevant.","min":0,"max":"1","base":{"path":"Patient.contact.organization","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"condition":["pat-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"},{"identity":"rim","map":"scoper"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.period","path":"Patient.contact.period","short":"The period during which this contact person or organization is valid to be contacted relating to this patient","definition":"The period during which this contact person or organization is valid to be contacted relating to this patient.","min":0,"max":"1","base":{"path":"Patient.contact.period","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"effectiveTime"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.communication","path":"Patient.communication","short":"A language which may be used to communicate with the patient about his or her health","definition":"A language which may be used to communicate with the patient about his or her health.","comment":"If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.","requirements":"If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.","min":0,"max":"*","base":{"path":"Patient.communication","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"LanguageCommunication"},{"identity":"interface","map":"ParticipantLiving.communication"},{"identity":"cda","map":"patient.languageCommunication"}]},{"id":"Patient.communication.id","path":"Patient.communication.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Patient.communication.extension","path":"Patient.communication.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Patient.communication.modifierExtension","path":"Patient.communication.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Patient.communication.language","path":"Patient.communication.language","short":"The language which can be used to communicate with the patient about his or her health","definition":"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-AU\" for Australian English.","comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","requirements":"Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.","min":1,"max":"1","base":{"path":"Patient.communication.language","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]},"mapping":[{"identity":"v2","map":"PID-15, LAN-2"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"},{"identity":"cda","map":".languageCode"}]},{"id":"Patient.communication.preferred","path":"Patient.communication.preferred","short":"Language preference indicator","definition":"Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).","comment":"This language is specifically identified for communicating healthcare information.","requirements":"People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.","min":0,"max":"1","base":{"path":"Patient.communication.preferred","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15"},{"identity":"rim","map":"preferenceInd"},{"identity":"cda","map":".preferenceInd"}]},{"id":"Patient.generalPractitioner","path":"Patient.generalPractitioner","short":"Patient's nominated primary care provider","definition":"Patient's nominated care provider.","comment":"This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.","alias":["careProvider"],"min":0,"max":"*","base":{"path":"Patient.generalPractitioner","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PD1-4"},{"identity":"rim","map":"subjectOf.CareEvent.performer.AssignedEntity"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.managingOrganization","path":"Patient.managingOrganization","short":"Organization that is the custodian of the patient record","definition":"Organization that is the custodian of the patient record.","comment":"There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).","requirements":"Need to know who recognizes this patient record, manages and updates it.","min":0,"max":"1","base":{"path":"Patient.managingOrganization","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"scoper"},{"identity":"cda","map":".providerOrganization"}]},{"id":"Patient.link","path":"Patient.link","short":"Link to a Patient or RelatedPerson resource that concerns the same actual individual","definition":"Link to a Patient or RelatedPerson resource that concerns the same actual individual.","comment":"There is no assumption that linked patient records have mutual links.","requirements":"There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.","min":0,"max":"*","base":{"path":"Patient.link","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'","isSummary":true,"mapping":[{"identity":"rim","map":"outboundLink"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.link.id","path":"Patient.link.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Patient.link.extension","path":"Patient.link.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Patient.link.modifierExtension","path":"Patient.link.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Patient.link.other","path":"Patient.link.other","short":"The other patient or related person resource that the link refers to","definition":"Link to a Patient or RelatedPerson resource that concerns the same actual individual.","comment":"Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.","min":1,"max":"1","base":{"path":"Patient.link.other","min":1,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":false}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-3, MRG-1"},{"identity":"rim","map":"id"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.link.type","path":"Patient.link.type","short":"replaced-by | replaces | refer | seealso","definition":"The type of link between this patient resource and another patient resource.","min":1,"max":"1","base":{"path":"Patient.link.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"LinkType"}],"strength":"required","description":"The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the `seealso` code","valueSet":"http://hl7.org/fhir/ValueSet/link-type|5.0.0"},"mapping":[{"identity":"rim","map":"typeCode"},{"identity":"cda","map":"n/a"}]}]},"differential":{"element":[{"id":"Patient","path":"Patient","short":"Information about an individual or animal receiving health care services","definition":"Demographics and other administrative information about an individual or animal receiving care or other health-related services.","alias":["SubjectOfCare Client Resident"],"min":0,"max":"*","mustSupport":false,"isModifier":false,"mapping":[{"identity":"w5","map":"administrative.individual"},{"identity":"rim","map":"Patient[classCode=PAT]"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"cda","map":"ClinicalDocument.recordTarget.patientRole"}]},{"id":"Patient.identifier","path":"Patient.identifier","short":"An identifier for this patient","definition":"An identifier for this patient.","requirements":"Patients are almost always assigned specific numerical identifiers.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"cda","map":".id"}]},{"id":"Patient.active","path":"Patient.active","short":"Whether this patient's record is in active use","definition":"Whether this patient record is in active use. \nMany 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.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.","comment":"If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.","requirements":"Need to be able to mark a patient record as not to be used because it was created in error.","min":0,"max":"1","type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"statusCode"},{"identity":"interface","map":"Participant.active"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.name","path":"Patient.name","short":"A name associated with the patient","definition":"A name associated with the individual.","comment":"A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.","requirements":"Need to be able to track the patient by multiple names. Examples are your official name and a partner name.","min":0,"max":"*","type":[{"code":"HumanName"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-5, PID-9"},{"identity":"rim","map":"name"},{"identity":"interface","map":"Participant.name"},{"identity":"cda","map":".patient.name"}]},{"id":"Patient.telecom","path":"Patient.telecom","short":"A contact detail for the individual","definition":"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.","comment":"A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).","requirements":"People have (primary) ways to contact them in some way such as phone, email.","min":0,"max":"*","type":[{"code":"ContactPoint"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-13, PID-14, PID-40"},{"identity":"rim","map":"telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"cda","map":".telecom"}]},{"id":"Patient.gender","path":"Patient.gender","short":"male | female | other | unknown","definition":"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.","comment":"The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.","requirements":"Needed for identification of the individual, in combination with (at least) name and birth date.","min":0,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The gender of a person used for administrative purposes.","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0"},"mapping":[{"identity":"v2","map":"PID-8"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"cda","map":".patient.administrativeGenderCode"}]},{"id":"Patient.birthDate","path":"Patient.birthDate","short":"The date of birth for the individual","definition":"The date of birth for the individual.","comment":"Partial dates are allowed if the specific date of birth is unknown. There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).","requirements":"Age of the individual drives many clinical processes.","min":0,"max":"1","type":[{"code":"date"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-7"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"cda","map":".patient.birthTime"},{"identity":"loinc","map":"21112-8"}]},{"id":"Patient.deceased[x]","path":"Patient.deceased[x]","short":"Indicates if the individual is deceased or not","definition":"Indicates if the individual is deceased or not.","comment":"If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.","requirements":"The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.","min":0,"max":"1","type":[{"code":"boolean"},{"code":"dateTime"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.","isSummary":true,"mapping":[{"identity":"v2","map":"PID-30 (bool) and PID-29 (datetime)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.address","path":"Patient.address","short":"An address for the individual","definition":"An address for the individual.","comment":"Patient may have multiple addresses with different uses or applicable periods.","requirements":"May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.","min":0,"max":"*","type":[{"code":"Address"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-11"},{"identity":"rim","map":"addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"cda","map":".addr"}]},{"id":"Patient.maritalStatus","path":"Patient.maritalStatus","short":"Marital (civil) status of a patient","definition":"This field contains a patient's most recent marital (civil) status.","requirements":"Most, if not all systems capture it.","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MaritalStatus"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"The domestic partnership status of a person.","valueSet":"http://hl7.org/fhir/ValueSet/marital-status"},"mapping":[{"identity":"v2","map":"PID-16"},{"identity":"rim","map":"player[classCode=PSN]/maritalStatusCode"},{"identity":"cda","map":".patient.maritalStatusCode"}]},{"id":"Patient.multipleBirth[x]","path":"Patient.multipleBirth[x]","short":"Whether patient is part of a multiple birth","definition":"Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).","comment":"Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).","requirements":"For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.","min":0,"max":"1","type":[{"code":"boolean"},{"code":"integer"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-24 (bool), PID-25 (integer)"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.photo","path":"Patient.photo","short":"Image of the patient","definition":"Image of the patient.","comment":"Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.","requirements":"Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.","min":0,"max":"*","type":[{"code":"Attachment"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-5 - needs a profile"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"Contact"}],"path":"Patient.contact","short":"A contact party (e.g. guardian, partner, friend) for the patient","definition":"A contact party (e.g. guardian, partner, friend) for the patient.","comment":"Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.","requirements":"Need to track people you can contact about the patient.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"constraint":[{"key":"pat-1","severity":"error","human":"SHALL at least contain a contact's details or a reference to an organization","expression":"name.exists() or telecom.exists() or address.exists() or organization.exists()","source":"http://hl7.org/fhir/StructureDefinition/Patient"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.relationship","path":"Patient.contact.relationship","short":"The kind of relationship","definition":"The nature of the relationship between the patient and the contact person.","requirements":"Used to determine which contact person is the most relevant to approach, depending on circumstances.","min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ContactRelationship"}],"strength":"extensible","description":"The nature of the relationship between a patient and a contact person for that patient.","valueSet":"http://hl7.org/fhir/ValueSet/patient-contactrelationship"},"mapping":[{"identity":"v2","map":"NK1-7, NK1-3"},{"identity":"rim","map":"code"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.name","path":"Patient.contact.name","short":"A name associated with the contact person","definition":"A name associated with the contact person.","requirements":"Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.","min":0,"max":"1","type":[{"code":"HumanName"}],"condition":["pat-1"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-2"},{"identity":"rim","map":"name"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.telecom","path":"Patient.contact.telecom","short":"A contact detail for the person","definition":"A contact detail for the person, e.g. a telephone number or an email address.","comment":"Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.","requirements":"People have (primary) ways to contact them in some way such as phone, email.","min":0,"max":"*","type":[{"code":"ContactPoint"}],"condition":["pat-1"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-5, NK1-6, NK1-40"},{"identity":"rim","map":"telecom"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.address","path":"Patient.contact.address","short":"Address for the contact person","definition":"Address for the contact person.","requirements":"Need to keep track where the contact person can be contacted per postal mail or visited.","min":0,"max":"1","type":[{"code":"Address"}],"condition":["pat-1"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-4"},{"identity":"rim","map":"addr"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.gender","path":"Patient.contact.gender","short":"male | female | other | unknown","definition":"Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.","requirements":"Needed to address the person correctly.","min":0,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The gender of a person used for administrative purposes.","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0"},"mapping":[{"identity":"v2","map":"NK1-15"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.organization","path":"Patient.contact.organization","short":"Organization that is associated with the contact","definition":"Organization on behalf of which the contact is acting or for which the contact is working.","requirements":"For guardians or business related contacts, the organization is relevant.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"condition":["pat-1"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"},{"identity":"rim","map":"scoper"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.contact.period","path":"Patient.contact.period","short":"The period during which this contact person or organization is valid to be contacted relating to this patient","definition":"The period during which this contact person or organization is valid to be contacted relating to this patient.","min":0,"max":"1","type":[{"code":"Period"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"effectiveTime"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.communication","path":"Patient.communication","short":"A language which may be used to communicate with the patient about his or her health","definition":"A language which may be used to communicate with the patient about his or her health.","comment":"If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.","requirements":"If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"LanguageCommunication"},{"identity":"interface","map":"ParticipantLiving.communication"},{"identity":"cda","map":"patient.languageCommunication"}]},{"id":"Patient.communication.language","path":"Patient.communication.language","short":"The language which can be used to communicate with the patient about his or her health","definition":"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-AU\" for Australian English.","comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","requirements":"Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]},"mapping":[{"identity":"v2","map":"PID-15, LAN-2"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"},{"identity":"cda","map":".languageCode"}]},{"id":"Patient.communication.preferred","path":"Patient.communication.preferred","short":"Language preference indicator","definition":"Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).","comment":"This language is specifically identified for communicating healthcare information.","requirements":"People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.","min":0,"max":"1","type":[{"code":"boolean"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15"},{"identity":"rim","map":"preferenceInd"},{"identity":"cda","map":".preferenceInd"}]},{"id":"Patient.generalPractitioner","path":"Patient.generalPractitioner","short":"Patient's nominated primary care provider","definition":"Patient's nominated care provider.","comment":"This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.","alias":["careProvider"],"min":0,"max":"*","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PD1-4"},{"identity":"rim","map":"subjectOf.CareEvent.performer.AssignedEntity"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.managingOrganization","path":"Patient.managingOrganization","short":"Organization that is the custodian of the patient record","definition":"Organization that is the custodian of the patient record.","comment":"There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).","requirements":"Need to know who recognizes this patient record, manages and updates it.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"scoper"},{"identity":"cda","map":".providerOrganization"}]},{"id":"Patient.link","path":"Patient.link","short":"Link to a Patient or RelatedPerson resource that concerns the same actual individual","definition":"Link to a Patient or RelatedPerson resource that concerns the same actual individual.","comment":"There is no assumption that linked patient records have mutual links.","requirements":"There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'","isSummary":true,"mapping":[{"identity":"rim","map":"outboundLink"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.link.other","path":"Patient.link.other","short":"The other patient or related person resource that the link refers to","definition":"Link to a Patient or RelatedPerson resource that concerns the same actual individual.","comment":"Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.","min":1,"max":"1","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":false}],"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PID-3, MRG-1"},{"identity":"rim","map":"id"},{"identity":"cda","map":"n/a"}]},{"id":"Patient.link.type","path":"Patient.link.type","short":"replaced-by | replaces | refer | seealso","definition":"The type of link between this patient resource and another patient resource.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"LinkType"}],"strength":"required","description":"The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the `seealso` code","valueSet":"http://hl7.org/fhir/ValueSet/link-type|5.0.0"},"mapping":[{"identity":"rim","map":"typeCode"},{"identity":"cda","map":"n/a"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Practitioner.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Practitioner.json index dc9fd2dcc..8dca1a052 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Practitioner.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Practitioner.json @@ -1 +1 @@ -{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/pafm/index.cfm"}]}],"date":"2021-04-14T05:30:20+00:00","derivation":"specialization","description":"A person who is directly or indirectly involved in the provisioning of healthcare.","differential":{"element":[{"definition":"A person who is directly or indirectly involved in the provisioning of healthcare.","id":"Practitioner","isModifier":false,"mapping":[{"identity":"v2","map":"PRD (as one example)"},{"identity":"rim","map":"Role"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"servd","map":"Provider"},{"identity":"w5","map":"administrative.individual"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner","short":"A person with a formal responsibility in the provisioning of healthcare or related services"},{"definition":"An identifier that applies to this person in this role.","id":"Practitioner.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PRD-7 (or XCN.1)"},{"identity":"rim","map":"./id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.identifier","requirements":"Often, specific identities are assigned for the agent.","short":"An identifier for the person as this agent","type":[{"code":"Identifier"}]},{"comment":"If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.","definition":"Whether this practitioner's record is in active use.","id":"Practitioner.active","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"./statusCode"},{"identity":"interface","map":"Participant.active"}],"max":"1","meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","min":0,"mustSupport":false,"path":"Practitioner.active","requirements":"Need to be able to mark a practitioner record as not to be used because it was created in error.","short":"Whether this practitioner's record is in active use","type":[{"code":"boolean"}]},{"comment":"The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. \r\rIn general, select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.","definition":"The name(s) associated with the practitioner.","id":"Practitioner.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XCN Components"},{"identity":"rim","map":"./name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":"./PreferredName (GivenNames, FamilyName, TitleCode)"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.name","requirements":"The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.","short":"The name(s) associated with the practitioner","type":[{"code":"HumanName"}]},{"comment":"Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.","definition":"A contact detail for the practitioner, e.g. a telephone number or an email address.","id":"Practitioner.telecom","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PRT-15, STF-10, ROL-12"},{"identity":"rim","map":"./telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"servd","map":"./ContactPoints"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.telecom","requirements":"Need to know how to reach a practitioner independent to any roles the practitioner may have.","short":"A contact detail for the practitioner (that apply to all roles)","type":[{"code":"ContactPoint"}]},{"comment":"The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).","definition":"Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.","id":"Practitioner.address","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"ORC-24, STF-11, ROL-11, PRT-14"},{"identity":"rim","map":"./addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"servd","map":"./Addresses"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.address","requirements":"The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.","short":"Address(es) of the practitioner that are not role specific (typically home address)","type":[{"code":"Address"}]},{"binding":{"description":"The gender of a person used for administrative purposes.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|4.6.0"},"definition":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.","id":"Practitioner.gender","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"STF-5"},{"identity":"rim","map":"./administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"servd","map":"./GenderCode"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.gender","requirements":"Needed to address the person correctly.","short":"male | female | other | unknown","type":[{"code":"code"}]},{"definition":"The date of birth for the practitioner.","id":"Practitioner.birthDate","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"STF-6"},{"identity":"rim","map":"./birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"servd","map":"(not represented in ServD)"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.birthDate","requirements":"Needed for identification.","short":"The date on which the practitioner was born","type":[{"code":"date"}]},{"definition":"Image of the person.","id":"Practitioner.photo","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"./subjectOf/ObservationEvent[code=\"photo\"]/value"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"servd","map":"./ImageURI (only supports the URI reference)"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.photo","requirements":"Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.","short":"Image of the person","type":[{"code":"Attachment"}]},{"definition":"The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.","id":"Practitioner.qualification","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"CER?"},{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.qualification","short":"Certification, licenses, or training pertaining to the provision of care","type":[{"code":"BackboneElement"}]},{"definition":"An identifier that applies to this person's qualification in this role.","id":"Practitioner.qualification.identifier","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].id"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.qualification.identifier","requirements":"Often, specific identities are assigned for the qualification.","short":"An identifier for this qualification for the practitioner","type":[{"code":"Identifier"}]},{"binding":{"description":"Specific qualification the practitioner has to provide a service.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Qualification"}],"strength":"example","valueSet":"http://terminology.hl7.org/ValueSet/v2-0360"},"definition":"Coded representation of the qualification.","id":"Practitioner.qualification.code","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications.Value"}],"max":"1","min":1,"mustSupport":false,"path":"Practitioner.qualification.code","short":"Coded representation of the qualification","type":[{"code":"CodeableConcept"}]},{"definition":"Period during which the qualification is valid.","id":"Practitioner.qualification.period","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].effectiveTime"},{"identity":"servd","map":"./Qualifications.StartDate and ./Qualifications.EndDate"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.qualification.period","requirements":"Qualifications are often for a limited period of time, and can be revoked.","short":"Period during which the qualification is valid","type":[{"code":"Period"}]},{"definition":"Organization that regulates and issues the qualification.","id":"Practitioner.qualification.issuer","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].scoper"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.qualification.issuer","short":"Organization that regulates and issues the qualification","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","definition":"A language the practitioner can use in patient communication.","id":"Practitioner.communication","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15, NK1-20, LAN-2"},{"identity":"rim","map":"./languageCommunication"},{"identity":"interface","map":"ParticipantLiving.communication"},{"identity":"servd","map":"./Languages.LanguageSpokenCode"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.communication","requirements":"Knowing which language a practitioner speaks can help in facilitating communication with patients.","short":"A language the practitioner can use in patient communication","type":[{"code":"CodeableConcept"}]}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":3},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"individual"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pa"}],"fhirVersion":"4.6.0","id":"Practitioner","kind":"resource","mapping":[{"identity":"v2","name":"HL7 v2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"interface","name":"Interface Pattern","uri":"http://hl7.org/fhir/interface"},{"identity":"servd","name":"ServD","uri":"http://www.omg.org/spec/ServD/1.0/"},{"identity":"w5","name":"FiveWs Pattern Mapping","uri":"http://hl7.org/fhir/fivews"}],"meta":{"lastUpdated":"2021-04-14T05:30:20.096+00:00"},"name":"Practitioner","publisher":"Health Level Seven International (Patient Administration)","purpose":"Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"Practitioner"},"constraint":[{"expression":"contained.contained.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","key":"dom-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(parent::f:contained and f:contained)"},{"expression":"contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","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","key":"dom-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"},{"expression":"contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated","key":"dom-4","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"},{"expression":"contained.meta.security.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a security label","key":"dom-5","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:security))"},{"expression":"text.`div`.exists()","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"human":"A resource should have narrative for robust management","key":"dom-6","severity":"warning","source":"http://hl7.org/fhir/StructureDefinition/DomainResource","xpath":"exists(f:text/h:div)"}],"definition":"A person who is directly or indirectly involved in the provisioning of healthcare.","id":"Practitioner","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act"},{"identity":"v2","map":"PRD (as one example)"},{"identity":"rim","map":"Role"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"servd","map":"Provider"},{"identity":"w5","map":"administrative.individual"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner","short":"A person with a formal responsibility in the provisioning of healthcare or related services"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"Typically, the resource has an id except for cases like the create operation, conditional updates.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Practitioner.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Practitioner.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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.","id":"Practitioner.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Practitioner.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","id":"Practitioner.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Practitioner.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The base language in which the resource is written.","id":"Practitioner.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"Practitioner.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"Contained resources do not have a 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 information is added later.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"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.","id":"Practitioner.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.","definition":"These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.","id":"Practitioner.contained","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"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.","id":"Practitioner.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Practitioner.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"base":{"max":"*","min":0,"path":"Practitioner.identifier"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"An identifier that applies to this person in this role.","id":"Practitioner.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PRD-7 (or XCN.1)"},{"identity":"rim","map":"./id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.identifier","requirements":"Often, specific identities are assigned for the agent.","short":"An identifier for the person as this agent","type":[{"code":"Identifier"}]},{"base":{"max":"1","min":0,"path":"Practitioner.active"},"comment":"If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Whether this practitioner's record is in active use.","id":"Practitioner.active","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"./statusCode"},{"identity":"interface","map":"Participant.active"}],"max":"1","meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","min":0,"mustSupport":false,"path":"Practitioner.active","requirements":"Need to be able to mark a practitioner record as not to be used because it was created in error.","short":"Whether this practitioner's record is in active use","type":[{"code":"boolean"}]},{"base":{"max":"*","min":0,"path":"Practitioner.name"},"comment":"The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. \r\rIn general, select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The name(s) associated with the practitioner.","id":"Practitioner.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XCN Components"},{"identity":"rim","map":"./name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":"./PreferredName (GivenNames, FamilyName, TitleCode)"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.name","requirements":"The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.","short":"The name(s) associated with the practitioner","type":[{"code":"HumanName"}]},{"base":{"max":"*","min":0,"path":"Practitioner.telecom"},"comment":"Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A contact detail for the practitioner, e.g. a telephone number or an email address.","id":"Practitioner.telecom","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PRT-15, STF-10, ROL-12"},{"identity":"rim","map":"./telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"servd","map":"./ContactPoints"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.telecom","requirements":"Need to know how to reach a practitioner independent to any roles the practitioner may have.","short":"A contact detail for the practitioner (that apply to all roles)","type":[{"code":"ContactPoint"}]},{"base":{"max":"*","min":0,"path":"Practitioner.address"},"comment":"The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.","id":"Practitioner.address","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"ORC-24, STF-11, ROL-11, PRT-14"},{"identity":"rim","map":"./addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"servd","map":"./Addresses"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.address","requirements":"The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.","short":"Address(es) of the practitioner that are not role specific (typically home address)","type":[{"code":"Address"}]},{"base":{"max":"1","min":0,"path":"Practitioner.gender"},"binding":{"description":"The gender of a person used for administrative purposes.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|4.6.0"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.","id":"Practitioner.gender","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"STF-5"},{"identity":"rim","map":"./administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"servd","map":"./GenderCode"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.gender","requirements":"Needed to address the person correctly.","short":"male | female | other | unknown","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"Practitioner.birthDate"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The date of birth for the practitioner.","id":"Practitioner.birthDate","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"STF-6"},{"identity":"rim","map":"./birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"servd","map":"(not represented in ServD)"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.birthDate","requirements":"Needed for identification.","short":"The date on which the practitioner was born","type":[{"code":"date"}]},{"base":{"max":"*","min":0,"path":"Practitioner.photo"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Image of the person.","id":"Practitioner.photo","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"./subjectOf/ObservationEvent[code=\"photo\"]/value"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"servd","map":"./ImageURI (only supports the URI reference)"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.photo","requirements":"Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.","short":"Image of the person","type":[{"code":"Attachment"}]},{"base":{"max":"*","min":0,"path":"Practitioner.qualification"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.","id":"Practitioner.qualification","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"CER?"},{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.qualification","short":"Certification, licenses, or training pertaining to the provision of care","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Practitioner.qualification.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Practitioner.qualification.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"Practitioner.qualification.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Practitioner.qualification.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"},{"expression":"extension.exists() != value.exists()","human":"Must have either extensions or value[x], not both","key":"ext-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Extension","xpath":"exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])"}],"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"Practitioner.qualification.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Practitioner.qualification.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"*","min":0,"path":"Practitioner.qualification.identifier"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"An identifier that applies to this person's qualification in this role.","id":"Practitioner.qualification.identifier","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].id"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.qualification.identifier","requirements":"Often, specific identities are assigned for the qualification.","short":"An identifier for this qualification for the practitioner","type":[{"code":"Identifier"}]},{"base":{"max":"1","min":1,"path":"Practitioner.qualification.code"},"binding":{"description":"Specific qualification the practitioner has to provide a service.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Qualification"}],"strength":"example","valueSet":"http://terminology.hl7.org/ValueSet/v2-0360"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Coded representation of the qualification.","id":"Practitioner.qualification.code","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications.Value"}],"max":"1","min":1,"mustSupport":false,"path":"Practitioner.qualification.code","short":"Coded representation of the qualification","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"Practitioner.qualification.period"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Period during which the qualification is valid.","id":"Practitioner.qualification.period","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].effectiveTime"},{"identity":"servd","map":"./Qualifications.StartDate and ./Qualifications.EndDate"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.qualification.period","requirements":"Qualifications are often for a limited period of time, and can be revoked.","short":"Period during which the qualification is valid","type":[{"code":"Period"}]},{"base":{"max":"1","min":0,"path":"Practitioner.qualification.issuer"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"Organization that regulates and issues the qualification.","id":"Practitioner.qualification.issuer","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].scoper"}],"max":"1","min":0,"mustSupport":false,"path":"Practitioner.qualification.issuer","short":"Organization that regulates and issues the qualification","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}]},{"base":{"max":"*","min":0,"path":"Practitioner.communication"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"A language the practitioner can use in patient communication.","id":"Practitioner.communication","isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"PID-15, NK1-20, LAN-2"},{"identity":"rim","map":"./languageCommunication"},{"identity":"interface","map":"ParticipantLiving.communication"},{"identity":"servd","map":"./Languages.LanguageSpokenCode"}],"max":"*","min":0,"mustSupport":false,"path":"Practitioner.communication","requirements":"Knowing which language a practitioner speaks can help in facilitating communication with patients.","short":"A language the practitioner can use in patient communication","type":[{"code":"CodeableConcept"}]}]},"status":"draft","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Practitioner TUDomainResourceA person with a formal responsibility in the provisioning of healthcare or related services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier Σ0..*IdentifierAn identifier for the person as this agent
\".\"\".\"\".\" active Σ0..1booleanWhether this practitioner's record is in active use
\".\"\".\"\".\" name Σ0..*HumanNameThe name(s) associated with the practitioner
\".\"\".\"\".\" telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
\".\"\".\"\".\" address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
\".\"\".\"\".\" gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
\".\"\".\"\".\" birthDate Σ0..1dateThe date on which the practitioner was born
\".\"\".\"\".\" photo 0..*AttachmentImage of the person
\".\"\".\"\".\" qualification 0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
\".\"\".\"\".\"\".\" identifier 0..*IdentifierAn identifier for this qualification for the practitioner
\".\"\".\"\".\"\".\" code 1..1CodeableConceptCoded representation of the qualification
hl7VS-degreeLicenseCertificate (Example)
\".\"\".\"\".\"\".\" period 0..1PeriodPeriod during which the qualification is valid
\".\"\".\"\".\"\".\" issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
\".\"\".\"\".\" communication 0..*CodeableConceptA language the practitioner can use in patient communication
Common Languages (Preferred but limited to AllLanguages)

\"doco\" Documentation for this format
","status":"generated"},"type":"Practitioner","url":"http://hl7.org/fhir/StructureDefinition/Practitioner","version":"4.6.0"} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Practitioner","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Practitioner\n \n \n TU\n \n \n DomainResource\n A person with a formal responsibility in the provisioning of healthcare or related services\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n 0..*\n Identifier\n An identifier for the person as this agent\n
\n
\n
\n \".\"\n \".\"\n \".\" \n active\n \n \n ?!\n Σ\n 0..1\n boolean\n Whether this practitioner's record is in active use\n
\n
\n \".\"\n \".\"\n \".\" \n name\n \n \n Σ\n 0..*\n HumanName\n The name(s) associated with the practitioner\n
\n
\n
\n \".\"\n \".\"\n \".\" \n telecom\n \n \n Σ\n 0..*\n ContactPoint\n A contact detail for the practitioner (that apply to all roles)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n gender\n \n \n Σ\n 0..1\n code\n male | female | other | unknown\n
Binding: \n AdministrativeGender (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n birthDate\n \n \n Σ\n 0..1\n date\n The date on which the practitioner was born\n
\n
\n \".\"\n \".\"\n \".\" \n deceased[x]\n \n \n Σ\n 0..1\n Indicates if the practitioner is deceased or not\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n deceasedBoolean\n \n \n \n boolean\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n deceasedDateTime\n \n \n \n dateTime\n \n
\n \".\"\n \".\"\n \".\" \n address\n \n \n Σ\n 0..*\n Address\n Address(es) of the practitioner that are not role specific (typically home address)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n photo\n \n \n 0..*\n Attachment\n Image of the person\n
\n
\n
\n \".\"\n \".\"\n \".\" \n qualification\n \n \n 0..*\n BackboneElement\n Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n identifier\n \n \n 0..*\n Identifier\n An identifier for this qualification for the practitioner\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n code\n \n \n 1..1\n CodeableConcept\n Coded representation of the qualification\n
Binding: \n hl7VS-degreeLicenseCertificate (\n Example)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n period\n \n \n 0..1\n Period\n Period during which the qualification is valid\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n issuer\n \n \n 0..1\n Reference(\n Organization)\n Organization that regulates and issues the qualification\n
\n
\n \".\"\n \".\"\n \".\" \n communication\n \n \n 0..*\n BackboneElement\n A language which may be used to communicate with the practitioner\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n language\n \n \n 1..1\n CodeableConcept\n The language code used to communicate with the practitioner\n
Binding: \n All Languages (\n Required)\n \n \n \n \n \n \n \n \n \n
\n Additional Bindings\n Purpose
\n Common Languages\n \n Starter Set\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n preferred\n \n \n 0..1\n boolean\n Language preference indicator\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Base.Individuals"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"individual"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pa"}],"url":"http://hl7.org/fhir/StructureDefinition/Practitioner","version":"5.0.0","name":"Practitioner","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+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":"A person who is directly or indirectly involved in the provisioning of healthcare or related services.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"purpose":"Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.","fhirVersion":"5.0.0","mapping":[{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"interface","uri":"http://hl7.org/fhir/interface","name":"Interface Pattern"},{"identity":"servd","uri":"http://www.omg.org/spec/ServD/1.0/","name":"ServD"}],"kind":"resource","abstract":false,"type":"Practitioner","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"Practitioner","path":"Practitioner","short":"A person with a formal responsibility in the provisioning of healthcare or related services","definition":"A person who is directly or indirectly involved in the provisioning of healthcare or related services.","min":0,"max":"*","base":{"path":"Practitioner","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Role"},{"identity":"w5","map":"administrative.individual"},{"identity":"v2","map":"PRD (as one example)"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"servd","map":"Provider"}]},{"id":"Practitioner.id","path":"Practitioner.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Practitioner.meta","path":"Practitioner.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Practitioner.implicitRules","path":"Practitioner.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Practitioner.language","path":"Practitioner.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Practitioner.text","path":"Practitioner.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Practitioner.contained","path":"Practitioner.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Practitioner.extension","path":"Practitioner.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Practitioner.modifierExtension","path":"Practitioner.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Practitioner.identifier","path":"Practitioner.identifier","short":"An identifier for the person as this agent","definition":"An identifier that applies to this person in this role.","requirements":"Often, specific identities are assigned for the agent.","min":0,"max":"*","base":{"path":"Practitioner.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PRD-7 (or XCN.1)"},{"identity":"rim","map":"./id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}]},{"id":"Practitioner.active","path":"Practitioner.active","short":"Whether this practitioner's record is in active use","definition":"Whether this practitioner's record is in active use.","comment":"If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.","requirements":"Need to be able to mark a practitioner record as not to be used because it was created in error.","min":0,"max":"1","base":{"path":"Practitioner.active","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"./statusCode"},{"identity":"interface","map":"Participant.active"}]},{"id":"Practitioner.name","path":"Practitioner.name","short":"The name(s) associated with the practitioner","definition":"The name(s) associated with the practitioner.","comment":"The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. \r\rIn general, select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.","requirements":"The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.","min":0,"max":"*","base":{"path":"Practitioner.name","min":0,"max":"*"},"type":[{"code":"HumanName"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XCN Components"},{"identity":"rim","map":"./name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":"./PreferredName (GivenNames, FamilyName, TitleCode)"}]},{"id":"Practitioner.telecom","path":"Practitioner.telecom","short":"A contact detail for the practitioner (that apply to all roles)","definition":"A contact detail for the practitioner, e.g. a telephone number or an email address.","comment":"Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.","requirements":"Need to know how to reach a practitioner independent to any roles the practitioner may have.","min":0,"max":"*","base":{"path":"Practitioner.telecom","min":0,"max":"*"},"type":[{"code":"ContactPoint"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PRT-15, STF-10, ROL-12"},{"identity":"rim","map":"./telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"servd","map":"./ContactPoints"}]},{"id":"Practitioner.gender","path":"Practitioner.gender","short":"male | female | other | unknown","definition":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.","requirements":"Needed to address the person correctly.","min":0,"max":"1","base":{"path":"Practitioner.gender","min":0,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The gender of a person used for administrative purposes.","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0"},"mapping":[{"identity":"v2","map":"STF-5"},{"identity":"rim","map":"./administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"servd","map":"./GenderCode"}]},{"id":"Practitioner.birthDate","path":"Practitioner.birthDate","short":"The date on which the practitioner was born","definition":"The date of birth for the practitioner.","requirements":"Needed for identification.","min":0,"max":"1","base":{"path":"Practitioner.birthDate","min":0,"max":"1"},"type":[{"code":"date"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"STF-6"},{"identity":"rim","map":"./birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"servd","map":"(not represented in ServD)"}]},{"id":"Practitioner.deceased[x]","path":"Practitioner.deceased[x]","short":"Indicates if the practitioner is deceased or not","definition":"Indicates if the practitioner is deceased or not.","comment":"If there's no value in the instance, it means there is no statement on whether or not the practitioner is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.","min":0,"max":"1","base":{"path":"Practitioner.deceased[x]","min":0,"max":"1"},"type":[{"code":"boolean"},{"code":"dateTime"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"}]},{"id":"Practitioner.address","path":"Practitioner.address","short":"Address(es) of the practitioner that are not role specific (typically home address)","definition":"Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.","comment":"The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).","requirements":"The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.","min":0,"max":"*","base":{"path":"Practitioner.address","min":0,"max":"*"},"type":[{"code":"Address"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"ORC-24, STF-11, ROL-11, PRT-14"},{"identity":"rim","map":"./addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"servd","map":"./Addresses"}]},{"id":"Practitioner.photo","path":"Practitioner.photo","short":"Image of the person","definition":"Image of the person.","requirements":"Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.","min":0,"max":"*","base":{"path":"Practitioner.photo","min":0,"max":"*"},"type":[{"code":"Attachment"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"./subjectOf/ObservationEvent[code=\"photo\"]/value"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"servd","map":"./ImageURI (only supports the URI reference)"}]},{"id":"Practitioner.qualification","path":"Practitioner.qualification","short":"Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care","definition":"The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner.\r\rFor example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality.","comment":"The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner.","min":0,"max":"*","base":{"path":"Practitioner.qualification","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"CER?"},{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications"}]},{"id":"Practitioner.qualification.id","path":"Practitioner.qualification.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Practitioner.qualification.extension","path":"Practitioner.qualification.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Practitioner.qualification.modifierExtension","path":"Practitioner.qualification.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Practitioner.qualification.identifier","path":"Practitioner.qualification.identifier","short":"An identifier for this qualification for the practitioner","definition":"An identifier that applies to this person's qualification.","requirements":"Often, specific identities are assigned for the qualification.","min":0,"max":"*","base":{"path":"Practitioner.qualification.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].id"}]},{"id":"Practitioner.qualification.code","path":"Practitioner.qualification.code","short":"Coded representation of the qualification","definition":"Coded representation of the qualification.","min":1,"max":"1","base":{"path":"Practitioner.qualification.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Qualification"}],"strength":"example","description":"Specific qualification the practitioner has to provide a service.","valueSet":"http://terminology.hl7.org/ValueSet/v2-0360"},"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications.Value"}]},{"id":"Practitioner.qualification.period","path":"Practitioner.qualification.period","short":"Period during which the qualification is valid","definition":"Period during which the qualification is valid.","requirements":"Qualifications are often for a limited period of time, and can be revoked.","min":0,"max":"1","base":{"path":"Practitioner.qualification.period","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].effectiveTime"},{"identity":"servd","map":"./Qualifications.StartDate and ./Qualifications.EndDate"}]},{"id":"Practitioner.qualification.issuer","path":"Practitioner.qualification.issuer","short":"Organization that regulates and issues the qualification","definition":"Organization that regulates and issues the qualification.","min":0,"max":"1","base":{"path":"Practitioner.qualification.issuer","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].scoper"}]},{"id":"Practitioner.communication","path":"Practitioner.communication","short":"A language which may be used to communicate with the practitioner","definition":"A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes.\r\rThe `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis).","comment":"If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations.\r\rFor animals, language is not a relevant field, and should be absent from the instance.","min":0,"max":"*","base":{"path":"Practitioner.communication","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"LanguageCommunication"}]},{"id":"Practitioner.communication.id","path":"Practitioner.communication.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Practitioner.communication.extension","path":"Practitioner.communication.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Practitioner.communication.modifierExtension","path":"Practitioner.communication.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Practitioner.communication.language","path":"Practitioner.communication.language","short":"The language code used to communicate with the practitioner","definition":"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-AU\" for Australian English.","comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","requirements":"Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.","min":1,"max":"1","base":{"path":"Practitioner.communication.language","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]},"mapping":[{"identity":"v2","map":"PID-15, LAN-2"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"}]},{"id":"Practitioner.communication.preferred","path":"Practitioner.communication.preferred","short":"Language preference indicator","definition":"Indicates whether or not the person prefers this language (over other languages he masters up a certain level).","comment":"This language is specifically identified for communicating directly with the practitioner (typically un-related to patient communications).","requirements":"People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.","min":0,"max":"1","base":{"path":"Practitioner.communication.preferred","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"preferenceInd"}]}]},"differential":{"element":[{"id":"Practitioner","path":"Practitioner","short":"A person with a formal responsibility in the provisioning of healthcare or related services","definition":"A person who is directly or indirectly involved in the provisioning of healthcare or related services.","min":0,"max":"*","mustSupport":false,"isModifier":false,"mapping":[{"identity":"w5","map":"administrative.individual"},{"identity":"v2","map":"PRD (as one example)"},{"identity":"rim","map":"Role"},{"identity":"interface","map":"ParticipantLiving"},{"identity":"servd","map":"Provider"}]},{"id":"Practitioner.identifier","path":"Practitioner.identifier","short":"An identifier for the person as this agent","definition":"An identifier that applies to this person in this role.","requirements":"Often, specific identities are assigned for the agent.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"PRD-7 (or XCN.1)"},{"identity":"rim","map":"./id"},{"identity":"interface","map":"Participant.identifier"},{"identity":"servd","map":"./Identifiers"}]},{"id":"Practitioner.active","path":"Practitioner.active","short":"Whether this practitioner's record is in active use","definition":"Whether this practitioner's record is in active use.","comment":"If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.","requirements":"Need to be able to mark a practitioner record as not to be used because it was created in error.","min":0,"max":"1","type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"./statusCode"},{"identity":"interface","map":"Participant.active"}]},{"id":"Practitioner.name","path":"Practitioner.name","short":"The name(s) associated with the practitioner","definition":"The name(s) associated with the practitioner.","comment":"The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. \r\rIn general, select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.","requirements":"The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.","min":0,"max":"*","type":[{"code":"HumanName"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XCN Components"},{"identity":"rim","map":"./name"},{"identity":"interface","map":"Participant.name"},{"identity":"servd","map":"./PreferredName (GivenNames, FamilyName, TitleCode)"}]},{"id":"Practitioner.telecom","path":"Practitioner.telecom","short":"A contact detail for the practitioner (that apply to all roles)","definition":"A contact detail for the practitioner, e.g. a telephone number or an email address.","comment":"Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.","requirements":"Need to know how to reach a practitioner independent to any roles the practitioner may have.","min":0,"max":"*","type":[{"code":"ContactPoint"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"PRT-15, STF-10, ROL-12"},{"identity":"rim","map":"./telecom"},{"identity":"interface","map":"ParticipantContactable.telecom"},{"identity":"servd","map":"./ContactPoints"}]},{"id":"Practitioner.gender","path":"Practitioner.gender","short":"male | female | other | unknown","definition":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.","requirements":"Needed to address the person correctly.","min":0,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AdministrativeGender"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The gender of a person used for administrative purposes.","valueSet":"http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0"},"mapping":[{"identity":"v2","map":"STF-5"},{"identity":"rim","map":"./administrativeGender"},{"identity":"interface","map":"ParticipantLiving.gender"},{"identity":"servd","map":"./GenderCode"}]},{"id":"Practitioner.birthDate","path":"Practitioner.birthDate","short":"The date on which the practitioner was born","definition":"The date of birth for the practitioner.","requirements":"Needed for identification.","min":0,"max":"1","type":[{"code":"date"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"STF-6"},{"identity":"rim","map":"./birthTime"},{"identity":"interface","map":"ParticipantLiving.birthDate"},{"identity":"servd","map":"(not represented in ServD)"}]},{"id":"Practitioner.deceased[x]","path":"Practitioner.deceased[x]","short":"Indicates if the practitioner is deceased or not","definition":"Indicates if the practitioner is deceased or not.","comment":"If there's no value in the instance, it means there is no statement on whether or not the practitioner is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.","min":0,"max":"1","type":[{"code":"boolean"},{"code":"dateTime"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"}]},{"id":"Practitioner.address","path":"Practitioner.address","short":"Address(es) of the practitioner that are not role specific (typically home address)","definition":"Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.","comment":"The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).","requirements":"The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.","min":0,"max":"*","type":[{"code":"Address"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"ORC-24, STF-11, ROL-11, PRT-14"},{"identity":"rim","map":"./addr"},{"identity":"interface","map":"ParticipantContactable.address"},{"identity":"servd","map":"./Addresses"}]},{"id":"Practitioner.photo","path":"Practitioner.photo","short":"Image of the person","definition":"Image of the person.","requirements":"Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.","min":0,"max":"*","type":[{"code":"Attachment"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"./subjectOf/ObservationEvent[code=\"photo\"]/value"},{"identity":"interface","map":"ParticipantLiving.photo"},{"identity":"servd","map":"./ImageURI (only supports the URI reference)"}]},{"id":"Practitioner.qualification","path":"Practitioner.qualification","short":"Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care","definition":"The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner.\r\rFor example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality.","comment":"The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"CER?"},{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications"}]},{"id":"Practitioner.qualification.identifier","path":"Practitioner.qualification.identifier","short":"An identifier for this qualification for the practitioner","definition":"An identifier that applies to this person's qualification.","requirements":"Often, specific identities are assigned for the qualification.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].id"}]},{"id":"Practitioner.qualification.code","path":"Practitioner.qualification.code","short":"Coded representation of the qualification","definition":"Coded representation of the qualification.","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Qualification"}],"strength":"example","description":"Specific qualification the practitioner has to provide a service.","valueSet":"http://terminology.hl7.org/ValueSet/v2-0360"},"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].code"},{"identity":"servd","map":"./Qualifications.Value"}]},{"id":"Practitioner.qualification.period","path":"Practitioner.qualification.period","short":"Period during which the qualification is valid","definition":"Period during which the qualification is valid.","requirements":"Qualifications are often for a limited period of time, and can be revoked.","min":0,"max":"1","type":[{"code":"Period"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].effectiveTime"},{"identity":"servd","map":"./Qualifications.StartDate and ./Qualifications.EndDate"}]},{"id":"Practitioner.qualification.issuer","path":"Practitioner.qualification.issuer","short":"Organization that regulates and issues the qualification","definition":"Organization that regulates and issues the qualification.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization"]}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":".playingEntity.playingRole[classCode=QUAL].scoper"}]},{"id":"Practitioner.communication","path":"Practitioner.communication","short":"A language which may be used to communicate with the practitioner","definition":"A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes.\r\rThe `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis).","comment":"If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations.\r\rFor animals, language is not a relevant field, and should be absent from the instance.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"LanguageCommunication"}]},{"id":"Practitioner.communication.language","path":"Practitioner.communication.language","short":"The language code used to communicate with the practitioner","definition":"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-AU\" for Australian English.","comment":"The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.","requirements":"Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]},"mapping":[{"identity":"v2","map":"PID-15, LAN-2"},{"identity":"rim","map":"player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"}]},{"id":"Practitioner.communication.preferred","path":"Practitioner.communication.preferred","short":"Language preference indicator","definition":"Indicates whether or not the person prefers this language (over other languages he masters up a certain level).","comment":"This language is specifically identified for communicating directly with the practitioner (typically un-related to patient communications).","requirements":"People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.","min":0,"max":"1","type":[{"code":"boolean"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"preferenceInd"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Resource.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Resource.json index 9180faa94..7475a462d 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Resource.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Resource.json @@ -1 +1 @@ -{"abstract":true,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/Base","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg/index.cfm"}]}],"date":"2021-04-14T05:30:20+00:00","derivation":"specialization","description":"This is the base resource type for everything.","differential":{"element":[{"definition":"This is the base resource type for everything.","id":"Resource","isModifier":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act"}],"max":"*","min":0,"mustSupport":false,"path":"Resource","short":"Base Resource"},{"comment":"Typically, the resource has an id except for cases like the create operation, conditional updates.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Resource.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Resource.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"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.","id":"Resource.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Resource.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.","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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","id":"Resource.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Resource.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"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).","definition":"The base language in which the resource is written.","id":"Resource.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"Resource.language","short":"Language of the resource content","type":[{"code":"code"}]}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"fhirVersion":"4.6.0","id":"Resource","kind":"resource","mapping":[{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"}],"meta":{"lastUpdated":"2021-04-14T05:30:20.096+00:00"},"name":"Resource","publisher":"Health Level Seven International (FHIR Infrastructure)","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"Resource"},"definition":"This is the base resource type for everything.","id":"Resource","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"},{"identity":"rim","map":"Entity. Role, or Act"}],"max":"*","min":0,"mustSupport":false,"path":"Resource","short":"Base Resource"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"Typically, the resource has an id except for cases like the create operation, conditional updates.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Resource.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Resource.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUri":"id"}]}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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.","id":"Resource.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Resource.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","id":"Resource.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Resource.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"IETF language tag","extension":[{"url":"http://hl7.org/fhir/build/StructureDefinition/definition","valueString":"A human language."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueCanonical":"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":"preferred","valueSet":"http://hl7.org/fhir/ValueSet/languages"},"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element","xpath":"@value|f:*|h:div"}],"definition":"The base language in which the resource is written.","id":"Resource.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"Resource.language","short":"Language of the resource content","type":[{"code":"code"}]}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Resource «I»NBaseBase Resource
Elements defined in Ancestors:
\".\"\".\"\".\" id Σ0..1idLogical id of this artifact
\".\"\".\"\".\" meta Σ0..1MetaMetadata about the resource
\".\"\".\"\".\" implicitRules ?!Σ0..1uriA set of rules under which this content was created
\".\"\".\"\".\" language 0..1codeLanguage of the resource content
Common Languages (Preferred but limited to AllLanguages)

\"doco\" Documentation for this format
","status":"generated"},"type":"Resource","url":"http://hl7.org/fhir/StructureDefinition/Resource","version":"4.6.0"} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Resource","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Resource\n \n \n «A»\n N\n \n \n Base\n Base Resource\n
\n
Elements defined in Ancestors: \n
\n \".\"\n \".\"\n \".\" \n id\n \n \n Σ\n 0..1\n id\n Logical id of this artifact\n
\n
\n \".\"\n \".\"\n \".\" \n meta\n \n \n Σ\n 0..1\n Meta\n Metadata about the resource\n
\n
\n \".\"\n \".\"\n \".\" \n implicitRules\n \n \n ?!\n Σ\n 0..1\n uri\n A set of rules under which this content was created\n
\n
\n \".\"\n \".\"\n \".\" \n language\n \n \n 0..1\n code\n Language of the resource content\n
Binding: \n All Languages (\n Required)\n \n \n \n \n \n \n \n \n \n
\n Additional Bindings\n Purpose
\n Common Languages\n \n Starter Set\n
\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"url":"http://hl7.org/fhir/StructureDefinition/Resource","version":"5.0.0","name":"Resource","status":"active","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (FHIR Infrastructure)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg/index.cfm"}]}],"description":"This is the base resource type for everything.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"}],"kind":"resource","abstract":true,"type":"Resource","baseDefinition":"http://hl7.org/fhir/StructureDefinition/Base","derivation":"specialization","snapshot":{"element":[{"id":"Resource","path":"Resource","short":"Base Resource","definition":"This is the base resource type for everything.","min":0,"max":"*","base":{"path":"Resource","min":0,"max":"*"},"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a,Entity. Role, or Act"}]},{"id":"Resource.id","path":"Resource.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Resource.meta","path":"Resource.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Resource.implicitRules","path":"Resource.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Resource.language","path":"Resource.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}}]},"differential":{"element":[{"id":"Resource","path":"Resource","short":"Base Resource","definition":"This is the base resource type for everything.","min":0,"max":"*","mustSupport":false,"isModifier":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act"}]},{"id":"Resource.id","path":"Resource.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Resource.meta","path":"Resource.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","type":[{"code":"Meta"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Resource.implicitRules","path":"Resource.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","type":[{"code":"uri"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Resource.language","path":"Resource.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","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Signature.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Signature.json index 97069c4f6..d0a55d830 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Signature.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-Signature.json @@ -1,562 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "Signature", - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" SignatureTUElementA Signature - XML DigSig, JWS, Graphical image of signature, etc.
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" typeΣ1..*CodingIndication of the reason the entity signed the object(s)
Signature Type Codes (Preferred)
\".\"\".\"\".\" whenΣ1..1instantWhen the signature was created
\".\"\".\"\".\" whoΣ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who signed
\".\"\".\"\".\" onBehalfOfΣ0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The party represented
\".\"\".\"\".\" targetFormat0..1codeThe technical format of the signed resources
MimeType (Required)
\".\"\".\"\".\" sigFormat0..1codeThe technical format of the signature
MimeType (Required)
\".\"\".\"\".\" data0..1base64BinaryThe actual signature content (XML DigSig. JWS, picture, etc.)

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/Signature", - "version" : "4.6.0", - "name" : "Signature", - "status" : "draft", - "date" : "2021-04-15T12:25:09+10:00", - "publisher" : "HL7 FHIR Standard", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }], - "description" : "Base StructureDefinition for Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.", - "purpose" : "There are a number of places where content must be signed in healthcare.", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }], - "kind" : "complex-type", - "abstract" : false, - "type" : "Signature", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DataType", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "Signature", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "path" : "Signature", - "short" : "A Signature - XML DigSig, JWS, Graphical image of signature, etc.", - "definition" : "A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.", - "comment" : "The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Signature", - "min" : 0, - "max" : "*" - }, - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }, - { - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Signature.id", - "path" : "Signature.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Signature.extension", - "path" : "Signature.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Signature.type", - "path" : "Signature.type", - "short" : "Indication of the reason the entity signed the object(s)", - "definition" : "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.", - "comment" : "Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".", - "min" : 1, - "max" : "*", - "base" : { - "path" : "Signature.type", - "min" : 1, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "An indication of the reason that an entity signed the object." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "SignatureType" - }], - "strength" : "preferred", - "valueSet" : "http://hl7.org/fhir/ValueSet/signature-type" - } - }, - { - "id" : "Signature.when", - "path" : "Signature.when", - "short" : "When the signature was created", - "definition" : "When the digital signature was signed.", - "comment" : "This should agree with the information in the signature.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Signature.when", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "instant" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Signature.who", - "path" : "Signature.who", - "short" : "Who signed", - "definition" : "A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).", - "comment" : "This should agree with the information in the signature.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Signature.who", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Signature.onBehalfOf", - "path" : "Signature.onBehalfOf", - "short" : "The party represented", - "definition" : "A reference to an application-usable description of the identity that is represented by the signature.", - "comment" : "The party that can't sign. For example a child.", - "requirements" : "used when the signature is on behalf of a non-signer.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Signature.onBehalfOf", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Signature.targetFormat", - "path" : "Signature.targetFormat", - "short" : "The technical format of the signed resources", - "definition" : "A mime type that indicates the technical format of the target resources signed by the signature.", - "comment" : "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Signature.targetFormat", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "The mime type of an attachment. Any valid mime type is allowed." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MimeType" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)", - "valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.6.0" - } - }, - { - "id" : "Signature.sigFormat", - "path" : "Signature.sigFormat", - "short" : "The technical format of the signature", - "definition" : "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Signature.sigFormat", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "The mime type of an attachment. Any valid mime type is allowed." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MimeType" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)", - "valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.6.0" - } - }, - { - "id" : "Signature.data", - "path" : "Signature.data", - "short" : "The actual signature content (XML DigSig. JWS, picture, etc.)", - "definition" : "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.", - "comment" : "Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) \"Detached Signature\" form.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Signature.data", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "base64Binary" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : false - }] - }, - "differential" : { - "element" : [{ - "id" : "Signature", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "path" : "Signature", - "short" : "A Signature - XML DigSig, JWS, Graphical image of signature, etc.", - "definition" : "A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.", - "comment" : "The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.", - "min" : 0, - "max" : "*", - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Signature.type", - "path" : "Signature.type", - "short" : "Indication of the reason the entity signed the object(s)", - "definition" : "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.", - "comment" : "Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".", - "min" : 1, - "max" : "*", - "type" : [{ - "code" : "Coding" - }], - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "An indication of the reason that an entity signed the object." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "SignatureType" - }], - "strength" : "preferred", - "valueSet" : "http://hl7.org/fhir/ValueSet/signature-type" - } - }, - { - "id" : "Signature.when", - "path" : "Signature.when", - "short" : "When the signature was created", - "definition" : "When the digital signature was signed.", - "comment" : "This should agree with the information in the signature.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "instant" - }], - "isSummary" : true - }, - { - "id" : "Signature.who", - "path" : "Signature.who", - "short" : "Who signed", - "definition" : "A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).", - "comment" : "This should agree with the information in the signature.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "isSummary" : true - }, - { - "id" : "Signature.onBehalfOf", - "path" : "Signature.onBehalfOf", - "short" : "The party represented", - "definition" : "A reference to an application-usable description of the identity that is represented by the signature.", - "comment" : "The party that can't sign. For example a child.", - "requirements" : "used when the signature is on behalf of a non-signer.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/Organization"] - }], - "isSummary" : true - }, - { - "id" : "Signature.targetFormat", - "path" : "Signature.targetFormat", - "short" : "The technical format of the signed resources", - "definition" : "A mime type that indicates the technical format of the target resources signed by the signature.", - "comment" : "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "The mime type of an attachment. Any valid mime type is allowed." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MimeType" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)", - "valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.6.0" - } - }, - { - "id" : "Signature.sigFormat", - "path" : "Signature.sigFormat", - "short" : "The technical format of the signature", - "definition" : "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "The mime type of an attachment. Any valid mime type is allowed." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "MimeType" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)", - "valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.6.0" - } - }, - { - "id" : "Signature.data", - "path" : "Signature.data", - "short" : "The actual signature content (XML DigSig. JWS, picture, etc.)", - "definition" : "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.", - "comment" : "Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) \"Detached Signature\" form.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "base64Binary" - }] - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"Signature","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n Signature\n \n TU\n \n \n Element\n A Signature - XML DigSig, JWS, Graphical image of signature, etc.\n
\n
Elements defined in Ancestors: \n id, \n extension\n
\n \".\"\n \".\"\n \".\" \n type\n \n Σ\n 0..*\n Coding\n Indication of the reason the entity signed the object(s)\n
Binding: \n Signature Type Codes (\n Preferred)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n when\n \n Σ\n 0..1\n instant\n When the signature was created\n
\n
\n \".\"\n \".\"\n \".\" \n who\n \n Σ\n 0..1\n Reference(\n Practitioner | \n PractitionerRole | \n RelatedPerson | \n Patient | \n Device | \n Organization)\n Who signed\n
\n
\n \".\"\n \".\"\n \".\" \n onBehalfOf\n \n Σ\n 0..1\n Reference(\n Practitioner | \n PractitionerRole | \n RelatedPerson | \n Patient | \n Device | \n Organization)\n The party represented\n
\n
\n \".\"\n \".\"\n \".\" \n targetFormat\n \n 0..1\n code\n The technical format of the signed resources\n
Binding: \n Mime Types (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n sigFormat\n \n 0..1\n code\n The technical format of the signature\n
Binding: \n Mime Types (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n data\n \n 0..1\n base64Binary\n The actual signature content (XML DigSig. JWS, picture, etc.)\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"url":"http://hl7.org/fhir/StructureDefinition/Signature","version":"5.0.0","name":"Signature","status":"draft","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"HL7 FHIR Standard","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]}],"description":"Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"purpose":"There are a number of places where content must be signed in healthcare.","fhirVersion":"5.0.0","mapping":[{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"}],"kind":"complex-type","abstract":false,"type":"Signature","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DataType","derivation":"specialization","snapshot":{"element":[{"id":"Signature","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Signature","short":"A Signature - XML DigSig, JWS, Graphical image of signature, etc.","definition":"A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.","comment":"The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.","min":0,"max":"*","base":{"path":"Signature","min":0,"max":"*"},"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"mapping":[{"identity":"rim","map":"n/a,N/A"}]},{"id":"Signature.id","path":"Signature.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Signature.extension","path":"Signature.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Signature.type","path":"Signature.type","short":"Indication of the reason the entity signed the object(s)","definition":"An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.","comment":"Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".","min":0,"max":"*","base":{"path":"Signature.type","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"An indication of the reason that an entity signed the object."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SignatureType"}],"strength":"preferred","description":"An indication of the reason that an entity signed the object.","valueSet":"http://hl7.org/fhir/ValueSet/signature-type"}},{"id":"Signature.when","path":"Signature.when","short":"When the signature was created","definition":"When the digital signature was signed.","comment":"This should agree with the information in the signature.","min":0,"max":"1","base":{"path":"Signature.when","min":0,"max":"1"},"type":[{"code":"instant"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true},{"id":"Signature.who","path":"Signature.who","short":"Who signed","definition":"A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).","comment":"This should agree with the information in the signature.","min":0,"max":"1","base":{"path":"Signature.who","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true},{"id":"Signature.onBehalfOf","path":"Signature.onBehalfOf","short":"The party represented","definition":"A reference to an application-usable description of the identity that is represented by the signature.","comment":"The party that can't sign. For example a child.","requirements":"used when the signature is on behalf of a non-signer.","min":0,"max":"1","base":{"path":"Signature.onBehalfOf","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true},{"id":"Signature.targetFormat","path":"Signature.targetFormat","short":"The technical format of the signed resources","definition":"A mime type that indicates the technical format of the target resources signed by the signature.","comment":"\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.","min":0,"max":"1","base":{"path":"Signature.targetFormat","min":0,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"The mime type of an attachment. Any valid mime type is allowed."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MimeType"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)","valueSet":"http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"}},{"id":"Signature.sigFormat","path":"Signature.sigFormat","short":"The technical format of the signature","definition":"A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.","min":0,"max":"1","base":{"path":"Signature.sigFormat","min":0,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"The mime type of an attachment. Any valid mime type is allowed."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MimeType"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)","valueSet":"http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"}},{"id":"Signature.data","path":"Signature.data","short":"The actual signature content (XML DigSig. JWS, picture, etc.)","definition":"The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.","comment":"Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) \"Detached Signature\" form.","min":0,"max":"1","base":{"path":"Signature.data","min":0,"max":"1"},"type":[{"code":"base64Binary"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":false}]},"differential":{"element":[{"id":"Signature","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Signature","short":"A Signature - XML DigSig, JWS, Graphical image of signature, etc.","definition":"A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.","comment":"The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.","min":0,"max":"*","mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Signature.type","path":"Signature.type","short":"Indication of the reason the entity signed the object(s)","definition":"An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.","comment":"Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".","min":0,"max":"*","type":[{"code":"Coding"}],"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"An indication of the reason that an entity signed the object."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SignatureType"}],"strength":"preferred","description":"An indication of the reason that an entity signed the object.","valueSet":"http://hl7.org/fhir/ValueSet/signature-type"}},{"id":"Signature.when","path":"Signature.when","short":"When the signature was created","definition":"When the digital signature was signed.","comment":"This should agree with the information in the signature.","min":0,"max":"1","type":[{"code":"instant"}],"isSummary":true},{"id":"Signature.who","path":"Signature.who","short":"Who signed","definition":"A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).","comment":"This should agree with the information in the signature.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization"]}],"isSummary":true},{"id":"Signature.onBehalfOf","path":"Signature.onBehalfOf","short":"The party represented","definition":"A reference to an application-usable description of the identity that is represented by the signature.","comment":"The party that can't sign. For example a child.","requirements":"used when the signature is on behalf of a non-signer.","min":0,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization"]}],"isSummary":true},{"id":"Signature.targetFormat","path":"Signature.targetFormat","short":"The technical format of the signed resources","definition":"A mime type that indicates the technical format of the target resources signed by the signature.","comment":"\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.","min":0,"max":"1","type":[{"code":"code"}],"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"The mime type of an attachment. Any valid mime type is allowed."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MimeType"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)","valueSet":"http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"}},{"id":"Signature.sigFormat","path":"Signature.sigFormat","short":"The technical format of the signature","definition":"A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.","min":0,"max":"1","type":[{"code":"code"}],"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"The mime type of an attachment. Any valid mime type is allowed."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MimeType"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)","valueSet":"http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"}},{"id":"Signature.data","path":"Signature.data","short":"The actual signature content (XML DigSig. JWS, picture, etc.)","definition":"The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.","comment":"Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) \"Detached Signature\" form.","min":0,"max":"1","type":[{"code":"base64Binary"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-StructureDefinition.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-StructureDefinition.json index 09c74810e..73c425f67 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-StructureDefinition.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-StructureDefinition.json @@ -1,3264 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "StructureDefinition", - "meta" : { - "lastUpdated" : "2021-04-14T05:30:20.096+00:00" - }, - "text" : { - "status" : "generated", - "div" : "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" StructureDefinition NCanonicalResourceStructural Definition
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Element paths must be unique unless the structure is a constraint
+ Rule: If the first element in a differential has no "." in the path and it's not a logical model, it has no type
+ Rule: If the structure is not abstract, then there SHALL be a baseDefinition
+ Rule: If the structure defines an extension then the structure must have context information
+ Rule: A structure must have either a differential, or a snapshot (or both)
+ Rule: In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element)
+ Rule: If there's a type, its content must match the path name in the first element of a snapshot
+ Rule: All element definitions must have an id
+ Rule: The first element in a snapshot has no type unless model is a logical model.
+ Rule: All element definitions must have unique ids (snapshot)
+ Rule: All element definitions must have unique ids (diff)
+ Rule: Context Invariants can only be used for extensions
+ Rule: FHIR Specification models only use FHIR defined types
+ Rule: Default values can only be specified on specializations
+ Rule: FHIR Specification models never have default values
+ Rule: No slice name on root
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright
\".\"\".\"\".\" url Σ1..1uriCanonical identifier for this structure definition, represented as a URI (globally unique)
\".\"\".\"\".\" identifier Σ0..*IdentifierAdditional identifier for the structure definition
\".\"\".\"\".\" version Σ0..1stringBusiness version of the structure definition
\".\"\".\"\".\" name ΣI1..1stringName for this structure definition (computer friendly)
\".\"\".\"\".\" title Σ0..1stringName for this structure definition (human friendly)
\".\"\".\"\".\" status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
\".\"\".\"\".\" experimental Σ0..1booleanFor testing purposes, not real usage
\".\"\".\"\".\" date Σ0..1dateTimeDate last changed
\".\"\".\"\".\" publisher Σ0..1stringName of the publisher (organization or individual)
\".\"\".\"\".\" contact Σ0..*ContactDetailContact details for the publisher
\".\"\".\"\".\" description 0..1markdownNatural language description of the structure definition
\".\"\".\"\".\" useContext ΣTU0..*UsageContextThe context that the content is intended to support
\".\"\".\"\".\" jurisdiction Σ0..*CodeableConceptIntended jurisdiction for structure definition (if applicable)
Jurisdiction (Extensible)
\".\"\".\"\".\" purpose 0..1markdownWhy this structure definition is defined
\".\"\".\"\".\" copyright 0..1markdownUse and/or publishing restrictions
\".\"\".\"\".\" keyword Σ0..*CodingAssist with indexing and finding
Structure Definition Use Codes / Keywords (Extensible)
\".\"\".\"\".\" fhirVersion Σ0..1codeFHIR Version this StructureDefinition targets
FHIRVersion (Required)
\".\"\".\"\".\" mapping I0..*BackboneElementExternal specification that the content is mapped to
+ Rule: Must have at least a name or a uri (or both)
\".\"\".\"\".\"\".\" identity 1..1idInternal id when this mapping is used
\".\"\".\"\".\"\".\" uri I0..1uriIdentifies what this mapping refers to
\".\"\".\"\".\"\".\" name I0..1stringNames what this mapping refers to
\".\"\".\"\".\"\".\" comment 0..1stringVersions, Issues, Scope limitations etc.
\".\"\".\"\".\" kind Σ1..1codeprimitive-type | complex-type | resource | logical
StructureDefinitionKind (Required)
\".\"\".\"\".\" abstract Σ1..1booleanWhether the structure is abstract
\".\"\".\"\".\" context ΣI0..*BackboneElementIf an extension, where it can be used in instances
\".\"\".\"\".\"\".\" type Σ1..1codefhirpath | element | extension
ExtensionContextType (Required)
\".\"\".\"\".\"\".\" expression Σ1..1stringWhere the extension can be used in instances
\".\"\".\"\".\" contextInvariant ΣI0..*stringFHIRPath invariants - when the extension can be used
\".\"\".\"\".\" type ΣI1..1uriType defined or constrained by this structure
FHIRDefinedType (Extensible)
\".\"\".\"\".\" baseDefinition ΣI0..1canonical(StructureDefinition)Definition that this type is constrained/specialized from
\".\"\".\"\".\" derivation Σ0..1codespecialization | constraint - How relates to base definition
TypeDerivationRule (Required)
\".\"\".\"\".\" snapshot I0..1BackboneElementSnapshot view of the structure
+ Rule: Each element definition in a snapshot must have a formal definition and cardinalities
+ Rule: All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models
+ Rule: All snapshot elements must have a base definition
\".\"\".\"\".\"\".\" element I1..*ElementDefinitionDefinition of elements in the resource (if no StructureDefinition)
+ Rule: provide either a binding reference or a description (or both)
\".\"\".\"\".\" differential I0..1BackboneElementDifferential view of the structure
+ Rule: No slicing on the root element
+ Rule: In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models
\".\"\".\"\".\"\".\" element 1..*ElementDefinitionDefinition of elements in the resource (if no StructureDefinition)

\"doco\" Documentation for this format
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "normative" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", - "valueCode" : "4.0.0" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 5 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", - "valueCode" : "anonymous" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "fhir" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition", - "version" : "4.6.0", - "name" : "StructureDefinition", - "status" : "active", - "date" : "2021-04-14T05:30:20+00:00", - "publisher" : "Health Level Seven International (FHIR Infrastructure)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }, - { - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm" - }] - }], - "description" : "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }, - { - "identity" : "workflow", - "uri" : "http://hl7.org/fhir/workflow", - "name" : "Workflow Pattern" - }, - { - "identity" : "iso11179", - "uri" : "http://metadata-standards.org/11179/", - "name" : "ISO 11179" - }, - { - "identity" : "objimpl", - "uri" : "http://hl7.org/fhir/object-implementation", - "name" : "Object Implementation Information" - }], - "kind" : "resource", - "abstract" : false, - "type" : "StructureDefinition", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/CanonicalResource", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "StructureDefinition", - "path" : "StructureDefinition", - "short" : "Structural Definition", - "definition" : "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "alias" : ["Template", - "Profile"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition", - "min" : 0, - "max" : "*" - }, - "constraint" : [{ - "key" : "cnl-0", - "severity" : "warning", - "human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation", - "expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')", - "xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-1", - "severity" : "error", - "human" : "Element paths must be unique unless the structure is a constraint", - "expression" : "derivation = 'constraint' or snapshot.element.select(path).isDistinct()", - "xpath" : "(f:derivation/@value = 'constraint') or (count(f:snapshot/f:element) = count(distinct-values(f:snapshot/f:element/f:path/@value)))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-15a", - "requirements" : "No Type on the root element (differential)", - "severity" : "error", - "human" : "If the first element in a differential has no \".\" in the path and it's not a logical model, it has no type", - "expression" : "(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()", - "xpath" : "f:kind/@value='logical' or not(f:differential/f:element[1][not(contains(f:path/@value, '.'))]/f:type)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-4", - "requirements" : "Ensure that the base types are abstract", - "severity" : "error", - "human" : "If the structure is not abstract, then there SHALL be a baseDefinition", - "expression" : "abstract = true or baseDefinition.exists()", - "xpath" : "(f:abstract/@value=true()) or exists(f:baseDefinition)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-5", - "severity" : "error", - "human" : "If the structure defines an extension then the structure must have context information", - "expression" : "type != 'Extension' or derivation = 'specialization' or (context.exists())", - "xpath" : "not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-6", - "severity" : "error", - "human" : "A structure must have either a differential, or a snapshot (or both)", - "expression" : "snapshot.exists() or differential.exists()", - "xpath" : "exists(f:snapshot) or exists(f:differential)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-9", - "requirements" : "Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition", - "severity" : "error", - "human" : "In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)", - "expression" : "children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()", - "xpath" : "not(exists(f:snapshot/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)])) and not(exists(f:differential/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)]))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-11", - "requirements" : "Ensure that the type is not inconsistent with the other information in the structure", - "severity" : "error", - "human" : "If there's a type, its content must match the path name in the first element of a snapshot", - "expression" : "kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type", - "xpath" : "(f:kind/@value = 'logical') or not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-14", - "requirements" : "elements have id", - "severity" : "error", - "human" : "All element definitions must have an id", - "expression" : "snapshot.element.all(id.exists()) and differential.element.all(id.exists())", - "xpath" : "count(*/f:element)=count(*/f:element/@id)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-15", - "requirements" : "No Type on the root element (snapshot)", - "severity" : "error", - "human" : "The first element in a snapshot has no type unless model is a logical model.", - "expression" : "kind!='logical' implies snapshot.element.first().type.empty()", - "xpath" : "f:kind/@value='logical' or not(f:snapshot/f:element[1]/f:type)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-16", - "requirements" : "element ids need to be unique", - "severity" : "error", - "human" : "All element definitions must have unique ids (snapshot)", - "expression" : "snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()", - "xpath" : "count(f:snapshot/f:element)=count(f:snapshot/f:element/@id) and (count(f:snapshot/f:element)=count(distinct-values(f:snapshot/f:element/@id)))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-17", - "requirements" : "element ids need to be unique", - "severity" : "error", - "human" : "All element definitions must have unique ids (diff)", - "expression" : "differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()", - "xpath" : "count(f:differential/f:element)=count(f:differential/f:element/@id) and (count(f:differential/f:element)=count(distinct-values(f:differential/f:element/@id)))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-18", - "requirements" : "contextInvariant", - "severity" : "error", - "human" : "Context Invariants can only be used for extensions", - "expression" : "contextInvariant.exists() implies type = 'Extension'", - "xpath" : "not(exists(f:contextInvariant)) or (f:type/@value = 'Extension')", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-19", - "requirements" : "custom types only in logical models", - "severity" : "error", - "human" : "FHIR Specification models only use FHIR defined types", - "expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential | snapshot).element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$'))", - "xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or count(f:differential/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]|f:snapshot/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]) =0", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-21", - "requirements" : "no default values on data types or resources", - "severity" : "error", - "human" : "Default values can only be specified on specializations", - "expression" : "differential.element.defaultValue.exists() implies (derivation = 'specialization')", - "xpath" : "not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])) or (f:derivation/@value = 'specialization')", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-22", - "requirements" : "no default values on data types or resources", - "severity" : "error", - "human" : "FHIR Specification models never have default values", - "expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())", - "xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or (not(exists(f:snapshot/f:element/*[starts-with(local-name(), 'defaultValue')])) and not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-23", - "requirements" : "no sliceName on root", - "severity" : "error", - "human" : "No slice name on root", - "expression" : "(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())", - "xpath" : "count(*[self::snapshot or self::differential]/f:element[not(contains(f:path/@value, '.')) and f:sliceName])=0", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition" - }, - { - "identity" : "rim", - "map" : "n/a" - }, - { - "identity" : "w5", - "map" : "conformance.content" - }] - }, - { - "id" : "StructureDefinition.id", - "path" : "StructureDefinition.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.meta", - "path" : "StructureDefinition.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.implicitRules", - "path" : "StructureDefinition.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "StructureDefinition.language", - "path" : "StructureDefinition.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "StructureDefinition.text", - "path" : "StructureDefinition.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "StructureDefinition.contained", - "path" : "StructureDefinition.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "StructureDefinition.extension", - "path" : "StructureDefinition.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "StructureDefinition.modifierExtension", - "path" : "StructureDefinition.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "StructureDefinition.url", - "path" : "StructureDefinition.url", - "short" : "Canonical identifier for this structure definition, represented as a URI (globally unique)", - "definition" : "An absolute URI that is used to identify this structure 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 structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.", - "comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.", - "requirements" : "Allows the structure definition to be referenced by a single globally unique identifier.", - "alias" : ["url", - "authoritative-url", - "destination", - "identity"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.url", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.url" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }] - }, - { - "id" : "StructureDefinition.identifier", - "path" : "StructureDefinition.identifier", - "short" : "Additional identifier for the structure definition", - "definition" : "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.", - "requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "iso11179", - "map" : "Identifier part" - }, - { - "identity" : "objimpl", - "map" : "no-gen-base" - }] - }, - { - "id" : "StructureDefinition.version", - "path" : "StructureDefinition.version", - "short" : "Business version of the structure definition", - "definition" : "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure 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.", - "comment" : "There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version].", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.version", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.version" - }, - { - "identity" : "w5", - "map" : "FiveWs.version" - }, - { - "identity" : "iso11179", - "map" : "Version" - }] - }, - { - "id" : "StructureDefinition.name", - "path" : "StructureDefinition.name", - "short" : "Name for this structure definition (computer friendly)", - "definition" : "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.Some Examples: \n\n* O2SatObservation\n* PresentationReport\n* Immunization2\n* AcmeAdmissionRecordOld.", - "requirements" : "Support human navigation and code generation.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.name", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "condition" : ["cnl-0"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.title", - "path" : "StructureDefinition.title", - "short" : "Name for this structure definition (human friendly)", - "definition" : "A short, descriptive, user-friendly title for the structure definition.", - "comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.title", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.title" - }] - }, - { - "id" : "StructureDefinition.status", - "path" : "StructureDefinition.status", - "short" : "draft | active | retired | unknown", - "definition" : "The status of this structure definition. Enables tracking the life-cycle of the content.", - "comment" : "Allows filtering of structure definitions that are appropriate for use versus not.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.status", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "PublicationStatus" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "The lifecycle status of an artifact.", - "valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.6.0|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.status" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "iso11179", - "map" : "Registration status" - }] - }, - { - "id" : "StructureDefinition.experimental", - "path" : "StructureDefinition.experimental", - "short" : "For testing purposes, not real usage", - "definition" : "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "comment" : "Allows filtering of structure definitions that are appropriate for use versus not.", - "requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.experimental", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.experimental" - }, - { - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "iso11179", - "map" : "Registration status" - }] - }, - { - "id" : "StructureDefinition.date", - "path" : "StructureDefinition.date", - "short" : "Date last changed", - "definition" : "The date (and optionally time) when the structure 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 structure definition changes.", - "comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.", - "alias" : ["Revision Date"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.date", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.date" - }, - { - "identity" : "w5", - "map" : "FiveWs.recorded" - }] - }, - { - "id" : "StructureDefinition.publisher", - "path" : "StructureDefinition.publisher", - "short" : "Name of the publisher (organization or individual)", - "definition" : "The name of the organization or individual that published the structure definition.", - "comment" : "Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.", - "requirements" : "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.publisher", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.publisher" - }, - { - "identity" : "w5", - "map" : "FiveWs.witness" - }, - { - "identity" : "iso11179", - "map" : "Registration Authority" - }] - }, - { - "id" : "StructureDefinition.contact", - "path" : "StructureDefinition.contact", - "short" : "Contact details for the publisher", - "definition" : "Contact details to assist a user in finding and communicating with the publisher.", - "comment" : "May be a web site, an email address, a telephone number, etc.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.contact", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "ContactDetail" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.contact" - }] - }, - { - "id" : "StructureDefinition.description", - "path" : "StructureDefinition.description", - "short" : "Natural language description of the structure definition", - "definition" : "A free text natural language description of the structure definition from a consumer's perspective.", - "comment" : "This description can be used to capture details such as why the structure definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure definition is presumed to be the predominant language in the place the structure definition was created).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.description", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "markdown" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.description" - }] - }, - { - "id" : "StructureDefinition.useContext", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "path" : "StructureDefinition.useContext", - "short" : "The context that the content is intended to support", - "definition" : "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 structure definition instances.", - "comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.", - "requirements" : "Assist in searching for appropriate content.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.useContext", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "UsageContext" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.useContext" - }] - }, - { - "id" : "StructureDefinition.jurisdiction", - "path" : "StructureDefinition.jurisdiction", - "short" : "Intended jurisdiction for structure definition (if applicable)", - "definition" : "A legal or geographic region in which the structure definition is intended to be used.", - "comment" : "It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.jurisdiction", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "Jurisdiction" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Countries and regions within which this artifact is targeted for use.", - "valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.jurisdiction" - }] - }, - { - "id" : "StructureDefinition.purpose", - "path" : "StructureDefinition.purpose", - "short" : "Why this structure definition is defined", - "definition" : "Explanation of why this structure definition is needed and why it has been designed as it has.", - "comment" : "This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.purpose", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "markdown" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.purpose" - }, - { - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "objimpl", - "map" : "no-gen-base" - }] - }, - { - "id" : "StructureDefinition.copyright", - "path" : "StructureDefinition.copyright", - "short" : "Use and/or publishing restrictions", - "definition" : "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.", - "requirements" : "Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.", - "alias" : ["License", - "Restrictions"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.copyright", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "markdown" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.copyright" - }, - { - "identity" : "objimpl", - "map" : "no-gen-base" - }] - }, - { - "id" : "StructureDefinition.keyword", - "path" : "StructureDefinition.keyword", - "short" : "Assist with indexing and finding", - "definition" : "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.", - "requirements" : "Assist in searching for appropriate StructureDefinitions.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.keyword", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "StructureDefinitionKeyword" - }], - "strength" : "extensible", - "description" : "Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).", - "valueSet" : "http://hl7.org/fhir/ValueSet/definition-use" - }, - "mapping" : [{ - "identity" : "iso11179", - "map" : "keywords" - }] - }, - { - "id" : "StructureDefinition.fhirVersion", - "path" : "StructureDefinition.fhirVersion", - "short" : "FHIR Version this StructureDefinition targets", - "definition" : "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.", - "comment" : "A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.fhirVersion", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "FHIRVersion" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "All published FHIR Versions.", - "valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.mapping", - "path" : "StructureDefinition.mapping", - "short" : "External specification that the content is mapped to", - "definition" : "An external specification that the content is mapped to.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.mapping", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "sdf-2", - "severity" : "error", - "human" : "Must have at least a name or a uri (or both)", - "expression" : "name.exists() or uri.exists()", - "xpath" : "exists(f:uri) or exists(f:name)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.id", - "path" : "StructureDefinition.mapping.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.mapping.extension", - "path" : "StructureDefinition.mapping.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.mapping.modifierExtension", - "path" : "StructureDefinition.mapping.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "StructureDefinition.mapping.identity", - "path" : "StructureDefinition.mapping.identity", - "short" : "Internal id when this mapping is used", - "definition" : "An Internal id that is used to identify this mapping set when specific mappings are made.", - "comment" : "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.mapping.identity", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "id" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.uri", - "path" : "StructureDefinition.mapping.uri", - "short" : "Identifies what this mapping refers to", - "definition" : "An absolute URI that identifies the specification that this mapping is expressed to.", - "comment" : "A formal identity for the specification being mapped to helps with identifying maps consistently.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.mapping.uri", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "condition" : ["sdf-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.name", - "path" : "StructureDefinition.mapping.name", - "short" : "Names what this mapping refers to", - "definition" : "A name for the specification that is being mapped to.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.mapping.name", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "condition" : ["sdf-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.comment", - "path" : "StructureDefinition.mapping.comment", - "short" : "Versions, Issues, Scope limitations etc.", - "definition" : "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.mapping.comment", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.kind", - "path" : "StructureDefinition.kind", - "short" : "primitive-type | complex-type | resource | logical", - "definition" : "Defines the kind of structure that this definition is describing.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.kind", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "StructureDefinitionKind" - }], - "strength" : "required", - "description" : "Defines the type of structure that a definition is describing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/structure-definition-kind|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.abstract", - "path" : "StructureDefinition.abstract", - "short" : "Whether the structure is abstract", - "definition" : "Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.", - "comment" : "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the StructureDefinition, but have children described, are anonymous concrete types that specialize Element.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.abstract", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.context", - "path" : "StructureDefinition.context", - "short" : "If an extension, where it can be used in instances", - "definition" : "Identifies the types of resource or data type elements to which the extension can be applied.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.context", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["sdf-5"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.context.id", - "path" : "StructureDefinition.context.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.context.extension", - "path" : "StructureDefinition.context.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.context.modifierExtension", - "path" : "StructureDefinition.context.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "StructureDefinition.context.type", - "path" : "StructureDefinition.context.type", - "short" : "fhirpath | element | extension", - "definition" : "Defines how to interpret the expression that defines what the context of the extension is.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.context.type", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ExtensionContextType" - }], - "strength" : "required", - "description" : "How an extension context is interpreted.", - "valueSet" : "http://hl7.org/fhir/ValueSet/extension-context-type|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.context.expression", - "path" : "StructureDefinition.context.expression", - "short" : "Where the extension can be used in instances", - "definition" : "An expression that defines where an extension can be used in resources.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.context.expression", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.contextInvariant", - "path" : "StructureDefinition.contextInvariant", - "short" : "FHIRPath invariants - when the extension can be used", - "definition" : "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.", - "comment" : "The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "StructureDefinition.contextInvariant", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "string" - }], - "condition" : ["sdf-18"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.type", - "path" : "StructureDefinition.type", - "short" : "Type defined or constrained by this structure", - "definition" : "The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.", - "comment" : "Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type is a URL, the type name SHOULD start with the tail of the type URL where required.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "StructureDefinition.type", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "condition" : ["sdf-11"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "FHIRDefinedTypeExt" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Either a resource or a data type, including logical model types.", - "valueSet" : "http://hl7.org/fhir/ValueSet/defined-types" - } - }, - { - "id" : "StructureDefinition.baseDefinition", - "path" : "StructureDefinition.baseDefinition", - "short" : "Definition that this type is constrained/specialized from", - "definition" : "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.", - "comment" : "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Element\" or another logical model.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.baseDefinition", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] - }], - "condition" : ["sdf-4"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.derivation", - "path" : "StructureDefinition.derivation", - "short" : "specialization | constraint - How relates to base definition", - "definition" : "How the type relates to the baseDefinition.", - "comment" : "If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.derivation", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "TypeDerivationRule" - }], - "strength" : "required", - "description" : "How a type relates to its baseDefinition.", - "valueSet" : "http://hl7.org/fhir/ValueSet/type-derivation-rule|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.snapshot", - "path" : "StructureDefinition.snapshot", - "short" : "Snapshot view of the structure", - "definition" : "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.snapshot", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["sdf-6"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "sdf-3", - "severity" : "error", - "human" : "Each element definition in a snapshot must have a formal definition and cardinalities", - "expression" : "element.all(definition.exists() and min.exists() and max.exists())", - "xpath" : "count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-8", - "severity" : "error", - "human" : "All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models", - "expression" : "(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))", - "xpath" : "f:element[1]/f:path/@value=parent::f:StructureDefinition/f:type/@value and count(f:element[position()!=1])=count(f:element[position()!=1][starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-8b", - "severity" : "error", - "human" : "All snapshot elements must have a base definition", - "expression" : "element.all(base.exists())", - "xpath" : "count(f:element) = count(f:element/f:base)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.snapshot.id", - "path" : "StructureDefinition.snapshot.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.snapshot.extension", - "path" : "StructureDefinition.snapshot.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.snapshot.modifierExtension", - "path" : "StructureDefinition.snapshot.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "StructureDefinition.snapshot.element", - "path" : "StructureDefinition.snapshot.element", - "short" : "Definition of elements in the resource (if no StructureDefinition)", - "definition" : "Captures constraints on each element within the resource.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "StructureDefinition.snapshot.element", - "min" : 1, - "max" : "*" - }, - "type" : [{ - "code" : "ElementDefinition" - }], - "condition" : ["sdf-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "sdf-10", - "requirements" : "binding is required", - "severity" : "error", - "human" : "provide either a binding reference or a description (or both)", - "expression" : "binding.empty() or binding.valueSet.exists() or binding.description.exists()", - "xpath" : "not(exists(f:binding)) or exists(f:binding/f:valueSet) or exists(f:binding/f:description)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "iso11179", - "map" : "--" - }] - }, - { - "id" : "StructureDefinition.differential", - "path" : "StructureDefinition.differential", - "short" : "Differential view of the structure", - "definition" : "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "StructureDefinition.differential", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["sdf-6"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "sdf-20", - "requirements" : "no slicing on root", - "severity" : "error", - "human" : "No slicing on the root element", - "expression" : "element.where(path.contains('.').not()).slicing.empty()", - "xpath" : "not(f:element[1]/f:slicing)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-8a", - "severity" : "error", - "human" : "In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models", - "expression" : "(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\\\..*','')&'.')))", - "xpath" : "count(f:element)=count(f:element[f:path/@value=ancestor::f:StructureDefinition/f:type/@value or starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.differential.id", - "path" : "StructureDefinition.differential.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.differential.extension", - "path" : "StructureDefinition.differential.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "StructureDefinition.differential.modifierExtension", - "path" : "StructureDefinition.differential.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "StructureDefinition.differential.element", - "path" : "StructureDefinition.differential.element", - "short" : "Definition of elements in the resource (if no StructureDefinition)", - "definition" : "Captures constraints on each element within the resource.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "StructureDefinition.differential.element", - "min" : 1, - "max" : "*" - }, - "type" : [{ - "code" : "ElementDefinition" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "iso11179", - "map" : "--" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "StructureDefinition", - "path" : "StructureDefinition", - "short" : "Structural Definition", - "definition" : "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "alias" : ["Template", - "Profile"], - "min" : 0, - "max" : "*", - "constraint" : [{ - "key" : "cnl-0", - "severity" : "warning", - "human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation", - "expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')", - "xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-9", - "requirements" : "Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition", - "severity" : "error", - "human" : "In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)", - "expression" : "children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()", - "xpath" : "not(exists(f:snapshot/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)])) and not(exists(f:differential/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)]))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-15a", - "requirements" : "No Type on the root element (differential)", - "severity" : "error", - "human" : "If the first element in a differential has no \".\" in the path and it's not a logical model, it has no type", - "expression" : "(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()", - "xpath" : "f:kind/@value='logical' or not(f:differential/f:element[1][not(contains(f:path/@value, '.'))]/f:type)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-19", - "requirements" : "custom types only in logical models", - "severity" : "error", - "human" : "FHIR Specification models only use FHIR defined types", - "expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential | snapshot).element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$'))", - "xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or count(f:differential/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]|f:snapshot/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]) =0", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-16", - "requirements" : "element ids need to be unique", - "severity" : "error", - "human" : "All element definitions must have unique ids (snapshot)", - "expression" : "snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()", - "xpath" : "count(f:snapshot/f:element)=count(f:snapshot/f:element/@id) and (count(f:snapshot/f:element)=count(distinct-values(f:snapshot/f:element/@id)))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-15", - "requirements" : "No Type on the root element (snapshot)", - "severity" : "error", - "human" : "The first element in a snapshot has no type unless model is a logical model.", - "expression" : "kind!='logical' implies snapshot.element.first().type.empty()", - "xpath" : "f:kind/@value='logical' or not(f:snapshot/f:element[1]/f:type)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-18", - "requirements" : "contextInvariant", - "severity" : "error", - "human" : "Context Invariants can only be used for extensions", - "expression" : "contextInvariant.exists() implies type = 'Extension'", - "xpath" : "not(exists(f:contextInvariant)) or (f:type/@value = 'Extension')", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-17", - "requirements" : "element ids need to be unique", - "severity" : "error", - "human" : "All element definitions must have unique ids (diff)", - "expression" : "differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()", - "xpath" : "count(f:differential/f:element)=count(f:differential/f:element/@id) and (count(f:differential/f:element)=count(distinct-values(f:differential/f:element/@id)))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-23", - "requirements" : "no sliceName on root", - "severity" : "error", - "human" : "No slice name on root", - "expression" : "(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())", - "xpath" : "count(*[self::snapshot or self::differential]/f:element[not(contains(f:path/@value, '.')) and f:sliceName])=0", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-11", - "requirements" : "Ensure that the type is not inconsistent with the other information in the structure", - "severity" : "error", - "human" : "If there's a type, its content must match the path name in the first element of a snapshot", - "expression" : "kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type", - "xpath" : "(f:kind/@value = 'logical') or not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-22", - "requirements" : "no default values on data types or resources", - "severity" : "error", - "human" : "FHIR Specification models never have default values", - "expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())", - "xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or (not(exists(f:snapshot/f:element/*[starts-with(local-name(), 'defaultValue')])) and not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-14", - "requirements" : "elements have id", - "severity" : "error", - "human" : "All element definitions must have an id", - "expression" : "snapshot.element.all(id.exists()) and differential.element.all(id.exists())", - "xpath" : "count(*/f:element)=count(*/f:element/@id)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-1", - "severity" : "error", - "human" : "Element paths must be unique unless the structure is a constraint", - "expression" : "derivation = 'constraint' or snapshot.element.select(path).isDistinct()", - "xpath" : "(f:derivation/@value = 'constraint') or (count(f:snapshot/f:element) = count(distinct-values(f:snapshot/f:element/f:path/@value)))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-21", - "requirements" : "no default values on data types or resources", - "severity" : "error", - "human" : "Default values can only be specified on specializations", - "expression" : "differential.element.defaultValue.exists() implies (derivation = 'specialization')", - "xpath" : "not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])) or (f:derivation/@value = 'specialization')", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-6", - "severity" : "error", - "human" : "A structure must have either a differential, or a snapshot (or both)", - "expression" : "snapshot.exists() or differential.exists()", - "xpath" : "exists(f:snapshot) or exists(f:differential)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-5", - "severity" : "error", - "human" : "If the structure defines an extension then the structure must have context information", - "expression" : "type != 'Extension' or derivation = 'specialization' or (context.exists())", - "xpath" : "not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context))", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-4", - "requirements" : "Ensure that the base types are abstract", - "severity" : "error", - "human" : "If the structure is not abstract, then there SHALL be a baseDefinition", - "expression" : "abstract = true or baseDefinition.exists()", - "xpath" : "(f:abstract/@value=true()) or exists(f:baseDefinition)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }, - { - "identity" : "w5", - "map" : "conformance.content" - }] - }, - { - "id" : "StructureDefinition.url", - "path" : "StructureDefinition.url", - "short" : "Canonical identifier for this structure definition, represented as a URI (globally unique)", - "definition" : "An absolute URI that is used to identify this structure 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 structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.", - "comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.", - "requirements" : "Allows the structure definition to be referenced by a single globally unique identifier.", - "alias" : ["url", - "authoritative-url", - "destination", - "identity"], - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.url" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }] - }, - { - "id" : "StructureDefinition.identifier", - "path" : "StructureDefinition.identifier", - "short" : "Additional identifier for the structure definition", - "definition" : "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.", - "requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Identifier" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "iso11179", - "map" : "Identifier part" - }, - { - "identity" : "objimpl", - "map" : "no-gen-base" - }] - }, - { - "id" : "StructureDefinition.version", - "path" : "StructureDefinition.version", - "short" : "Business version of the structure definition", - "definition" : "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure 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.", - "comment" : "There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version].", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.version" - }, - { - "identity" : "w5", - "map" : "FiveWs.version" - }, - { - "identity" : "iso11179", - "map" : "Version" - }] - }, - { - "id" : "StructureDefinition.name", - "path" : "StructureDefinition.name", - "short" : "Name for this structure definition (computer friendly)", - "definition" : "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.Some Examples: \n\n* O2SatObservation\n* PresentationReport\n* Immunization2\n* AcmeAdmissionRecordOld.", - "requirements" : "Support human navigation and code generation.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "condition" : ["cnl-0"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.title", - "path" : "StructureDefinition.title", - "short" : "Name for this structure definition (human friendly)", - "definition" : "A short, descriptive, user-friendly title for the structure definition.", - "comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.title" - }] - }, - { - "id" : "StructureDefinition.status", - "path" : "StructureDefinition.status", - "short" : "draft | active | retired | unknown", - "definition" : "The status of this structure definition. Enables tracking the life-cycle of the content.", - "comment" : "Allows filtering of structure definitions that are appropriate for use versus not.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "PublicationStatus" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "The lifecycle status of an artifact.", - "valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.6.0|4.6.0" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.status" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "iso11179", - "map" : "Registration status" - }] - }, - { - "id" : "StructureDefinition.experimental", - "path" : "StructureDefinition.experimental", - "short" : "For testing purposes, not real usage", - "definition" : "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "comment" : "Allows filtering of structure definitions that are appropriate for use versus not.", - "requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.experimental" - }, - { - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "iso11179", - "map" : "Registration status" - }] - }, - { - "id" : "StructureDefinition.date", - "path" : "StructureDefinition.date", - "short" : "Date last changed", - "definition" : "The date (and optionally time) when the structure 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 structure definition changes.", - "comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.", - "alias" : ["Revision Date"], - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "dateTime" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.date" - }, - { - "identity" : "w5", - "map" : "FiveWs.recorded" - }] - }, - { - "id" : "StructureDefinition.publisher", - "path" : "StructureDefinition.publisher", - "short" : "Name of the publisher (organization or individual)", - "definition" : "The name of the organization or individual that published the structure definition.", - "comment" : "Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.", - "requirements" : "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.publisher" - }, - { - "identity" : "w5", - "map" : "FiveWs.witness" - }, - { - "identity" : "iso11179", - "map" : "Registration Authority" - }] - }, - { - "id" : "StructureDefinition.contact", - "path" : "StructureDefinition.contact", - "short" : "Contact details for the publisher", - "definition" : "Contact details to assist a user in finding and communicating with the publisher.", - "comment" : "May be a web site, an email address, a telephone number, etc.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "ContactDetail" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.contact" - }] - }, - { - "id" : "StructureDefinition.description", - "path" : "StructureDefinition.description", - "short" : "Natural language description of the structure definition", - "definition" : "A free text natural language description of the structure definition from a consumer's perspective.", - "comment" : "This description can be used to capture details such as why the structure definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure definition is presumed to be the predominant language in the place the structure definition was created).", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "markdown" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.description" - }] - }, - { - "id" : "StructureDefinition.useContext", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "path" : "StructureDefinition.useContext", - "short" : "The context that the content is intended to support", - "definition" : "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 structure definition instances.", - "comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.", - "requirements" : "Assist in searching for appropriate content.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "UsageContext" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.useContext" - }] - }, - { - "id" : "StructureDefinition.jurisdiction", - "path" : "StructureDefinition.jurisdiction", - "short" : "Intended jurisdiction for structure definition (if applicable)", - "definition" : "A legal or geographic region in which the structure definition is intended to be used.", - "comment" : "It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "Jurisdiction" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Countries and regions within which this artifact is targeted for use.", - "valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.jurisdiction" - }] - }, - { - "id" : "StructureDefinition.purpose", - "path" : "StructureDefinition.purpose", - "short" : "Why this structure definition is defined", - "definition" : "Explanation of why this structure definition is needed and why it has been designed as it has.", - "comment" : "This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "markdown" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.purpose" - }, - { - "identity" : "w5", - "map" : "FiveWs.why[x]" - }, - { - "identity" : "objimpl", - "map" : "no-gen-base" - }] - }, - { - "id" : "StructureDefinition.copyright", - "path" : "StructureDefinition.copyright", - "short" : "Use and/or publishing restrictions", - "definition" : "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.", - "requirements" : "Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.", - "alias" : ["License", - "Restrictions"], - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "markdown" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "workflow", - "map" : "Definition.copyright" - }, - { - "identity" : "objimpl", - "map" : "no-gen-base" - }] - }, - { - "id" : "StructureDefinition.keyword", - "path" : "StructureDefinition.keyword", - "short" : "Assist with indexing and finding", - "definition" : "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.", - "requirements" : "Assist in searching for appropriate StructureDefinitions.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "Coding" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "StructureDefinitionKeyword" - }], - "strength" : "extensible", - "description" : "Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).", - "valueSet" : "http://hl7.org/fhir/ValueSet/definition-use" - }, - "mapping" : [{ - "identity" : "iso11179", - "map" : "keywords" - }] - }, - { - "id" : "StructureDefinition.fhirVersion", - "path" : "StructureDefinition.fhirVersion", - "short" : "FHIR Version this StructureDefinition targets", - "definition" : "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.", - "comment" : "A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "FHIRVersion" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "required", - "description" : "All published FHIR Versions.", - "valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.mapping", - "path" : "StructureDefinition.mapping", - "short" : "External specification that the content is mapped to", - "definition" : "An external specification that the content is mapped to.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "sdf-2", - "severity" : "error", - "human" : "Must have at least a name or a uri (or both)", - "expression" : "name.exists() or uri.exists()", - "xpath" : "exists(f:uri) or exists(f:name)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.identity", - "path" : "StructureDefinition.mapping.identity", - "short" : "Internal id when this mapping is used", - "definition" : "An Internal id that is used to identify this mapping set when specific mappings are made.", - "comment" : "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "id" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.uri", - "path" : "StructureDefinition.mapping.uri", - "short" : "Identifies what this mapping refers to", - "definition" : "An absolute URI that identifies the specification that this mapping is expressed to.", - "comment" : "A formal identity for the specification being mapped to helps with identifying maps consistently.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "condition" : ["sdf-2"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.name", - "path" : "StructureDefinition.mapping.name", - "short" : "Names what this mapping refers to", - "definition" : "A name for the specification that is being mapped to.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "condition" : ["sdf-2"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.mapping.comment", - "path" : "StructureDefinition.mapping.comment", - "short" : "Versions, Issues, Scope limitations etc.", - "definition" : "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.kind", - "path" : "StructureDefinition.kind", - "short" : "primitive-type | complex-type | resource | logical", - "definition" : "Defines the kind of structure that this definition is describing.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "StructureDefinitionKind" - }], - "strength" : "required", - "description" : "Defines the type of structure that a definition is describing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/structure-definition-kind|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.abstract", - "path" : "StructureDefinition.abstract", - "short" : "Whether the structure is abstract", - "definition" : "Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.", - "comment" : "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the StructureDefinition, but have children described, are anonymous concrete types that specialize Element.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.context", - "path" : "StructureDefinition.context", - "short" : "If an extension, where it can be used in instances", - "definition" : "Identifies the types of resource or data type elements to which the extension can be applied.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["sdf-5"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.context.type", - "path" : "StructureDefinition.context.type", - "short" : "fhirpath | element | extension", - "definition" : "Defines how to interpret the expression that defines what the context of the extension is.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ExtensionContextType" - }], - "strength" : "required", - "description" : "How an extension context is interpreted.", - "valueSet" : "http://hl7.org/fhir/ValueSet/extension-context-type|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.context.expression", - "path" : "StructureDefinition.context.expression", - "short" : "Where the extension can be used in instances", - "definition" : "An expression that defines where an extension can be used in resources.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.contextInvariant", - "path" : "StructureDefinition.contextInvariant", - "short" : "FHIRPath invariants - when the extension can be used", - "definition" : "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.", - "comment" : "The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.", - "min" : 0, - "max" : "*", - "type" : [{ - "code" : "string" - }], - "condition" : ["sdf-18"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.type", - "path" : "StructureDefinition.type", - "short" : "Type defined or constrained by this structure", - "definition" : "The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.", - "comment" : "Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type is a URL, the type name SHOULD start with the tail of the type URL where required.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "condition" : ["sdf-11"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "FHIRDefinedTypeExt" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Either a resource or a data type, including logical model types.", - "valueSet" : "http://hl7.org/fhir/ValueSet/defined-types" - } - }, - { - "id" : "StructureDefinition.baseDefinition", - "path" : "StructureDefinition.baseDefinition", - "short" : "Definition that this type is constrained/specialized from", - "definition" : "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.", - "comment" : "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Element\" or another logical model.", - "min" : 0, - "max" : "1", - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", - "valueBoolean" : true - }], - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] - }], - "condition" : ["sdf-4"], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "StructureDefinition.derivation", - "path" : "StructureDefinition.derivation", - "short" : "specialization | constraint - How relates to base definition", - "definition" : "How the type relates to the baseDefinition.", - "comment" : "If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "TypeDerivationRule" - }], - "strength" : "required", - "description" : "How a type relates to its baseDefinition.", - "valueSet" : "http://hl7.org/fhir/ValueSet/type-derivation-rule|4.6.0|4.6.0" - } - }, - { - "id" : "StructureDefinition.snapshot", - "path" : "StructureDefinition.snapshot", - "short" : "Snapshot view of the structure", - "definition" : "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["sdf-6"], - "constraint" : [{ - "key" : "sdf-8", - "severity" : "error", - "human" : "All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models", - "expression" : "(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))", - "xpath" : "f:element[1]/f:path/@value=parent::f:StructureDefinition/f:type/@value and count(f:element[position()!=1])=count(f:element[position()!=1][starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-3", - "severity" : "error", - "human" : "Each element definition in a snapshot must have a formal definition and cardinalities", - "expression" : "element.all(definition.exists() and min.exists() and max.exists())", - "xpath" : "count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-8b", - "severity" : "error", - "human" : "All snapshot elements must have a base definition", - "expression" : "element.all(base.exists())", - "xpath" : "count(f:element) = count(f:element/f:base)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.snapshot.element", - "path" : "StructureDefinition.snapshot.element", - "short" : "Definition of elements in the resource (if no StructureDefinition)", - "definition" : "Captures constraints on each element within the resource.", - "min" : 1, - "max" : "*", - "type" : [{ - "code" : "ElementDefinition" - }], - "condition" : ["sdf-3"], - "constraint" : [{ - "key" : "sdf-10", - "requirements" : "binding is required", - "severity" : "error", - "human" : "provide either a binding reference or a description (or both)", - "expression" : "binding.empty() or binding.valueSet.exists() or binding.description.exists()", - "xpath" : "not(exists(f:binding)) or exists(f:binding/f:valueSet) or exists(f:binding/f:description)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "iso11179", - "map" : "--" - }] - }, - { - "id" : "StructureDefinition.differential", - "path" : "StructureDefinition.differential", - "short" : "Differential view of the structure", - "definition" : "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["sdf-6"], - "constraint" : [{ - "key" : "sdf-20", - "requirements" : "no slicing on root", - "severity" : "error", - "human" : "No slicing on the root element", - "expression" : "element.where(path.contains('.').not()).slicing.empty()", - "xpath" : "not(f:element[1]/f:slicing)", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }, - { - "key" : "sdf-8a", - "severity" : "error", - "human" : "In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models", - "expression" : "(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\\\..*','')&'.')))", - "xpath" : "count(f:element)=count(f:element[f:path/@value=ancestor::f:StructureDefinition/f:type/@value or starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])", - "source" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "StructureDefinition.differential.element", - "path" : "StructureDefinition.differential.element", - "short" : "Definition of elements in the resource (if no StructureDefinition)", - "definition" : "Captures constraints on each element within the resource.", - "min" : 1, - "max" : "*", - "type" : [{ - "code" : "ElementDefinition" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "iso11179", - "map" : "--" - }] - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"StructureDefinition","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n
\n Name\n \n Flags\n \n Card.\n \n Type\n \n Description & Constraints\n \n \n \"doco\"\n \n \n
\n \".\"\n \".\" \n StructureDefinition\n \n \n N\n \n \n DomainResource\n Structural Definition\n
\n + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation\n
\n + Rule: Element paths must be unique unless the structure is a constraint\n
\n + Rule: If the structure is not abstract, then there SHALL be a baseDefinition\n
\n + Rule: If the structure defines an extension then the structure must have context information\n
\n + Rule: A structure must have either a differential, or a snapshot (or both)\n
\n + Rule: If there's a type, its content must match the path name in the first element of a snapshot\n
\n + Rule: All element definitions must have an id\n
\n + Rule: The first element in a snapshot has no type unless model is a logical model.\n
\n + Rule: If the first element in a differential has no "." in the path and it's not a logical model, it has no type\n
\n + Rule: In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element)\n
\n + Rule: All element definitions must have unique ids (snapshot)\n
\n + Rule: All element definitions must have unique ids (diff)\n
\n + Rule: Context Invariants can only be used for extensions\n
\n + Rule: FHIR Specification models only use FHIR defined types\n
\n + Rule: Default values can only be specified on specializations\n
\n + Rule: FHIR Specification models never have default values\n
\n + Rule: No slice name on root\n
\n + Rule: If there's a base definition, there must be a derivation \n
\n + Warning: Elements in Resources must have a min cardinality or 0 or 1 and a max cardinality of 1 or *\n
\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension\n
\n Interfaces Implemented: \n CanonicalResource\n
\n \".\"\n \".\"\n \".\" \n url\n \n \n Σ\n C\n 1..1\n uri\n Canonical identifier for this structure definition, represented as a URI (globally unique)\n
\n + Warning: URL should not contain | or # - these characters make processing canonical references problematic\n
\n
\n \".\"\n \".\"\n \".\" \n identifier\n \n \n Σ\n 0..*\n Identifier\n Additional identifier for the structure definition\n
\n
\n
\n \".\"\n \".\"\n \".\" \n version\n \n \n Σ\n 0..1\n string\n Business version of the structure definition\n
\n
\n \".\"\n \".\"\n \".\" \n versionAlgorithm[x]\n \n \n Σ\n TU\n 0..1\n How to compare versions\n
Binding: \n Version Algorithm (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n versionAlgorithmString\n \n \n \n string\n \n
\n \".\"\n \".\"\n \".\"\n \".\" \n versionAlgorithmCoding\n \n \n \n Coding\n \n
\n \".\"\n \".\"\n \".\" \n name\n \n \n Σ\n C\n 1..1\n string\n Name for this structure definition (computer friendly)\n
\n
\n \".\"\n \".\"\n \".\" \n title\n \n \n Σ\n T\n 0..1\n string\n Name for this structure definition (human friendly)\n
\n
\n \".\"\n \".\"\n \".\" \n status\n \n \n ?!\n Σ\n 1..1\n code\n draft | active | retired | unknown\n
Binding: \n PublicationStatus (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n experimental\n \n \n Σ\n 0..1\n boolean\n For testing purposes, not real usage\n
\n
\n \".\"\n \".\"\n \".\" \n date\n \n \n Σ\n 0..1\n dateTime\n Date last changed\n
\n
\n \".\"\n \".\"\n \".\" \n publisher\n \n \n Σ\n T\n 0..1\n string\n Name of the publisher/steward (organization or individual)\n
\n
\n \".\"\n \".\"\n \".\" \n contact\n \n \n Σ\n 0..*\n ContactDetail\n Contact details for the publisher\n
\n
\n
\n \".\"\n \".\"\n \".\" \n description\n \n \n T\n 0..1\n markdown\n Natural language description of the structure definition\n
\n
\n \".\"\n \".\"\n \".\" \n useContext\n \n \n Σ\n TU\n 0..*\n UsageContext\n The context that the content is intended to support\n
\n
\n
\n \".\"\n \".\"\n \".\" \n jurisdiction\n \n \n Σ\n XD\n 0..*\n CodeableConcept\n Intended jurisdiction for structure definition (if applicable)\n
Binding: \n Jurisdiction ValueSet (\n Extensible)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n purpose\n \n \n T\n 0..1\n markdown\n Why this structure definition is defined\n
\n
\n \".\"\n \".\"\n \".\" \n copyright\n \n \n T\n 0..1\n markdown\n Use and/or publishing restrictions\n
\n
\n \".\"\n \".\"\n \".\" \n copyrightLabel\n \n \n T\n TU\n 0..1\n string\n Copyright holder and year(s)\n
\n
\n \".\"\n \".\"\n \".\" \n keyword\n \n \n Σ\n XD\n 0..*\n Coding\n Assist with indexing and finding\n
Binding: \n Structure Definition Use Codes / Keywords (\n Extensible)\n
\n
\n
\n \".\"\n \".\"\n \".\" \n fhirVersion\n \n \n Σ\n 0..1\n code\n FHIR Version this StructureDefinition targets\n
Binding: \n FHIRVersion (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n mapping\n \n \n C\n 0..*\n BackboneElement\n External specification that the content is mapped to\n
\n + Rule: Must have at least a name or a uri (or both)\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n identity\n \n \n 1..1\n id\n Internal id when this mapping is used\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n uri\n \n \n C\n 0..1\n uri\n Identifies what this mapping refers to\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n name\n \n \n C\n 0..1\n string\n Names what this mapping refers to\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n comment\n \n \n 0..1\n string\n Versions, Issues, Scope limitations etc\n
\n
\n \".\"\n \".\"\n \".\" \n kind\n \n \n Σ\n C\n 1..1\n code\n primitive-type | complex-type | resource | logical\n
Binding: \n Structure Definition Kind (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n abstract\n \n \n Σ\n C\n 1..1\n boolean\n Whether the structure is abstract\n
\n
\n \".\"\n \".\"\n \".\" \n context\n \n \n Σ\n C\n 0..*\n BackboneElement\n If an extension, where it can be used in instances\n
\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n type\n \n \n Σ\n 1..1\n code\n fhirpath | element | extension\n
Binding: \n Extension Context Type (\n Required)\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n expression\n \n \n Σ\n 1..1\n string\n Where the extension can be used in instances\n
\n
\n \".\"\n \".\"\n \".\" \n contextInvariant\n \n \n Σ\n C\n 0..*\n string\n FHIRPath invariants - when the extension can be used\n
\n
\n
\n \".\"\n \".\"\n \".\" \n type\n \n \n Σ\n C\n 1..1\n uri\n Type defined or constrained by this structure\n
Binding: \n All FHIR Types (\n Extensible)\n
\n
\n \".\"\n \".\"\n \".\" \n baseDefinition\n \n \n Σ\n C\n 0..1\n canonical(\n StructureDefinition)\n Definition that this type is constrained/specialized from\n
\n
\n \".\"\n \".\"\n \".\" \n derivation\n \n \n Σ\n C\n 0..1\n code\n specialization | constraint - How relates to base definition\n
Binding: \n Type Derivation Rule (\n Required)\n
\n
\n \".\"\n \".\"\n \".\" \n snapshot\n \n \n C\n 0..1\n BackboneElement\n Snapshot view of the structure\n
\n + Rule: Each element definition in a snapshot must have a formal definition and cardinalities, unless model is a logical model\n
\n + Rule: All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models\n
\n + Rule: For CodeableReference elements, target profiles must be listed on the CodeableReference, not the CodeableReference.reference\n
\n + Rule: For CodeableReference elements, bindings must be listed on the CodeableReference, not the CodeableReference.concept\n
\n + Guideline: The root element of a profile should not have mustSupport = true\n
\n + Rule: All snapshot elements must have a base definition\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n element\n \n \n C\n 1..*\n ElementDefinition\n Definition of elements in the resource (if no StructureDefinition)\n
\n + Rule: provide either a binding reference or a description (or both)\n
\n + Rule: If there are no discriminators, there must be a definition\n
\n
\n
\n \".\"\n \".\"\n \".\" \n differential\n \n \n C\n 0..1\n BackboneElement\n Differential view of the structure\n
\n + Rule: No slicing on the root element\n
\n + Rule: In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models\n
\n
\n \".\"\n \".\"\n \".\"\n \".\" \n element\n \n \n C\n 1..*\n ElementDefinition\n Definition of elements in the resource (if no StructureDefinition)\n
\n
\n
\n
\n \n \"doco\" Documentation for this format\n \n
\n
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Foundation.Conformance"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-implements","valueUri":"http://hl7.org/fhir/StructureDefinition/CanonicalResource"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"anonymous"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"url":"http://hl7.org/fhir/StructureDefinition/StructureDefinition","version":"5.0.0","name":"StructureDefinition","status":"active","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"Health Level Seven International (FHIR Infrastructure)","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg/index.cfm"}]}],"description":"A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","mapping":[{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"iso11179","uri":"http://metadata-standards.org/11179/","name":"ISO 11179"},{"identity":"objimpl","uri":"http://hl7.org/fhir/object-implementation","name":"Object Implementation Information"}],"kind":"resource","abstract":false,"type":"StructureDefinition","baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","derivation":"specialization","snapshot":{"element":[{"id":"StructureDefinition","path":"StructureDefinition","short":"Structural Definition","definition":"A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.","alias":["Template","Profile"],"min":0,"max":"*","base":{"path":"StructureDefinition","min":0,"max":"*"},"constraint":[{"key":"cnl-0","severity":"warning","human":"Name should be usable as an identifier for the module by machine processing applications such as code generation","expression":"name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-1","severity":"error","human":"Element paths must be unique unless the structure is a constraint","expression":"derivation = 'constraint' or snapshot.element.select(path).isDistinct()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-4","requirements":"Ensure that the base types are abstract","severity":"error","human":"If the structure is not abstract, then there SHALL be a baseDefinition","expression":"abstract = true or baseDefinition.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-5","severity":"error","human":"If the structure defines an extension then the structure must have context information","expression":"type != 'Extension' or derivation = 'specialization' or (context.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-6","severity":"error","human":"A structure must have either a differential, or a snapshot (or both)","expression":"snapshot.exists() or differential.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-11","requirements":"Ensure that the type is not inconsistent with the other information in the structure","severity":"error","human":"If there's a type, its content must match the path name in the first element of a snapshot","expression":"kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-14","requirements":"elements have id","severity":"error","human":"All element definitions must have an id","expression":"snapshot.element.all(id.exists()) and differential.element.all(id.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-15","requirements":"No Type on the root element (snapshot)","severity":"error","human":"The first element in a snapshot has no type unless model is a logical model.","expression":"kind!='logical' implies snapshot.element.first().type.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-15a","requirements":"No Type on the root element (differential)","severity":"error","human":"If the first element in a differential has no \".\" in the path and it's not a logical model, it has no type","expression":"(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-9","requirements":"Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition","severity":"error","human":"In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)","expression":"children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-16","requirements":"element ids need to be unique","severity":"error","human":"All element definitions must have unique ids (snapshot)","expression":"snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-17","requirements":"element ids need to be unique","severity":"error","human":"All element definitions must have unique ids (diff)","expression":"differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-18","requirements":"contextInvariant","severity":"error","human":"Context Invariants can only be used for extensions","expression":"contextInvariant.exists() implies type = 'Extension'","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-19","requirements":"custom types only in logical models","severity":"error","human":"FHIR Specification models only use FHIR defined types","expression":"url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential | snapshot).element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$'))","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-21","requirements":"no default values on data types or resources","severity":"error","human":"Default values can only be specified on specializations","expression":"differential.element.defaultValue.exists() implies (derivation = 'specialization')","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-22","requirements":"no default values on data types or resources","severity":"error","human":"FHIR Specification models never have default values","expression":"url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-23","requirements":"no sliceName on root","severity":"error","human":"No slice name on root","expression":"(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-27","severity":"error","human":"If there's a base definition, there must be a derivation ","expression":"baseDefinition.exists() implies derivation.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-29","severity":"warning","human":"Elements in Resources must have a min cardinality or 0 or 1 and a max cardinality of 1 or *","expression":"((kind in 'resource' | 'complex-type') and (derivation = 'specialization')) implies differential.element.where((min != 0 and min != 1) or (max != '1' and max != '*')).empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"conformance.behavior,conformance.content"},{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.id","path":"StructureDefinition.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.meta","path":"StructureDefinition.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.implicitRules","path":"StructureDefinition.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"StructureDefinition.language","path":"StructureDefinition.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"StructureDefinition.text","path":"StructureDefinition.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"StructureDefinition.contained","path":"StructureDefinition.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"StructureDefinition.extension","path":"StructureDefinition.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"StructureDefinition.modifierExtension","path":"StructureDefinition.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"StructureDefinition.url","path":"StructureDefinition.url","short":"Canonical identifier for this structure definition, represented as a URI (globally unique)","definition":"An absolute URI that is used to identify this structure 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 an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.","comment":"Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.","requirements":"Allows the structure definition to be referenced by a single globally unique identifier.","alias":["url","authoritative-url","destination","identity"],"min":1,"max":"1","base":{"path":"StructureDefinition.url","min":1,"max":"1"},"type":[{"code":"uri"}],"condition":["sdf-19","sdf-22"],"constraint":[{"key":"cnl-1","severity":"warning","human":"URL should not contain | or # - these characters make processing canonical references problematic","expression":"exists() implies matches('^[^|# ]+$')","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"}]},{"id":"StructureDefinition.identifier","path":"StructureDefinition.identifier","short":"Additional identifier for the structure definition","definition":"A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.","comment":"Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.","requirements":"Allows externally provided and/or usable business identifiers to be easily associated with the module.","min":0,"max":"*","base":{"path":"StructureDefinition.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"iso11179","map":"Identifier part"},{"identity":"objimpl","map":"no-gen-base"}]},{"id":"StructureDefinition.version","path":"StructureDefinition.version","short":"Business version of the structure definition","definition":"The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. There is no expectation that versions can be placed in a lexicographical sequence, so authors are encouraged to populate the StructureDefinition.versionAlgorithm[x] element to enable comparisons. If there is no managed version available, authors can consider using ISO date/time syntax (e.g., '2023-01-01').","comment":"There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).","min":0,"max":"1","base":{"path":"StructureDefinition.version","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.version"},{"identity":"iso11179","map":"Version"}]},{"id":"StructureDefinition.versionAlgorithm[x]","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"StructureDefinition.versionAlgorithm[x]","short":"How to compare versions","definition":"Indicates the mechanism used to compare versions to determine which is more current.","comment":"If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.","min":0,"max":"1","base":{"path":"StructureDefinition.versionAlgorithm[x]","min":0,"max":"1"},"type":[{"code":"string"},{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/version-algorithm"}},{"id":"StructureDefinition.name","path":"StructureDefinition.name","short":"Name for this structure definition (computer friendly)","definition":"A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.","comment":"The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.Some Examples: \n\n* O2SatObservation\n* PresentationReport\n* Immunization2\n* AcmeAdmissionRecordOld.","requirements":"Support human navigation and code generation.","min":1,"max":"1","base":{"path":"StructureDefinition.name","min":1,"max":"1"},"type":[{"code":"string"}],"condition":["cnl-0"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.title","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.title","short":"Name for this structure definition (human friendly)","definition":"A short, descriptive, user-friendly title for the structure definition.","comment":"This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.","min":0,"max":"1","base":{"path":"StructureDefinition.title","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.status","path":"StructureDefinition.status","short":"draft | active | retired | unknown","definition":"The status of this structure definition. Enables tracking the life-cycle of the content.","comment":"Allows filtering of structure definitions that are appropriate for use versus not.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).","min":1,"max":"1","base":{"path":"StructureDefinition.status","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"PublicationStatus"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The lifecycle status of an artifact.","valueSet":"http://hl7.org/fhir/ValueSet/publication-status|5.0.0"},"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"iso11179","map":"Registration status"}]},{"id":"StructureDefinition.experimental","path":"StructureDefinition.experimental","short":"For testing purposes, not real usage","definition":"A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.","comment":"Allows filtering of structure definitions that are appropriate for use versus not.","requirements":"Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.","min":0,"max":"1","base":{"path":"StructureDefinition.experimental","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"If absent, this resource is treated as though it is not experimental.","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"iso11179","map":"Registration status"}]},{"id":"StructureDefinition.date","path":"StructureDefinition.date","short":"Date last changed","definition":"The date (and optionally time) when the structure definition was last significantly changed. 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 structure definition changes.","comment":"The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).","alias":["Revision Date"],"min":0,"max":"1","base":{"path":"StructureDefinition.date","min":0,"max":"1"},"type":[{"code":"dateTime"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"}]},{"id":"StructureDefinition.publisher","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.publisher","short":"Name of the publisher/steward (organization or individual)","definition":"The name of the organization or individual responsible for the release and ongoing maintenance of the structure definition.","comment":"Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.","requirements":"Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.","min":0,"max":"1","base":{"path":"StructureDefinition.publisher","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.witness"},{"identity":"iso11179","map":"Registration Authority"}]},{"id":"StructureDefinition.contact","path":"StructureDefinition.contact","short":"Contact details for the publisher","definition":"Contact details to assist a user in finding and communicating with the publisher.","comment":"May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).","min":0,"max":"*","base":{"path":"StructureDefinition.contact","min":0,"max":"*"},"type":[{"code":"ContactDetail"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.description","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.description","short":"Natural language description of the structure definition","definition":"A free text natural language description of the structure definition from a consumer's perspective.","comment":"This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure definition is presumed to be the predominant language in the place the structure definition was created).","min":0,"max":"1","base":{"path":"StructureDefinition.description","min":0,"max":"1"},"type":[{"code":"markdown"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.useContext","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"StructureDefinition.useContext","short":"The context that the content is intended to support","definition":"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 structure definition instances.","comment":"When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.","requirements":"Assist in searching for appropriate content.","min":0,"max":"*","base":{"path":"StructureDefinition.useContext","min":0,"max":"*"},"type":[{"code":"UsageContext"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.jurisdiction","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"deprecated"}],"path":"StructureDefinition.jurisdiction","short":"Intended jurisdiction for structure definition (if applicable)","definition":"A legal or geographic region in which the structure definition is intended to be used.","comment":"It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)","min":0,"max":"*","base":{"path":"StructureDefinition.jurisdiction","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Jurisdiction"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Countries and regions within which this artifact is targeted for use.","valueSet":"http://hl7.org/fhir/ValueSet/jurisdiction"}},{"id":"StructureDefinition.purpose","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.purpose","short":"Why this structure definition is defined","definition":"Explanation of why this structure definition is needed and why it has been designed as it has.","comment":"This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.","min":0,"max":"1","base":{"path":"StructureDefinition.purpose","min":0,"max":"1"},"type":[{"code":"markdown"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"objimpl","map":"no-gen-base"}]},{"id":"StructureDefinition.copyright","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.copyright","short":"Use and/or publishing restrictions","definition":"A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.","comment":"...","requirements":"Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.","alias":["License","Restrictions"],"min":0,"max":"1","base":{"path":"StructureDefinition.copyright","min":0,"max":"1"},"type":[{"code":"markdown"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"objimpl","map":"no-gen-base"}]},{"id":"StructureDefinition.copyrightLabel","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.copyrightLabel","short":"Copyright holder and year(s)","definition":"A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').","comment":"The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.","requirements":"Defines the content expected to be rendered in all representations of the artifact.","min":0,"max":"1","base":{"path":"StructureDefinition.copyrightLabel","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.keyword","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"deprecated"}],"path":"StructureDefinition.keyword","short":"Assist with indexing and finding","definition":"(DEPRECATED) A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.","comment":"Note that this element is deprecated. Use the [http://hl7.org/fhir/StructureDefinition/artifact-topic](http://hl7.org/fhir/extensions/StructureDefinition-artifact-topic.html) extension instead.","requirements":"Assist in searching for appropriate StructureDefinitions.","min":0,"max":"*","base":{"path":"StructureDefinition.keyword","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"StructureDefinitionKeyword"}],"strength":"extensible","description":"Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).","valueSet":"http://hl7.org/fhir/ValueSet/definition-use"},"mapping":[{"identity":"iso11179","map":"keywords"}]},{"id":"StructureDefinition.fhirVersion","path":"StructureDefinition.fhirVersion","short":"FHIR Version this StructureDefinition targets","definition":"The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.","comment":"A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.","min":0,"max":"1","base":{"path":"StructureDefinition.fhirVersion","min":0,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FHIRVersion"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"All published FHIR Versions.","valueSet":"http://hl7.org/fhir/ValueSet/FHIR-version|5.0.0"}},{"id":"StructureDefinition.mapping","path":"StructureDefinition.mapping","short":"External specification that the content is mapped to","definition":"An external specification that the content is mapped to.","min":0,"max":"*","base":{"path":"StructureDefinition.mapping","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"sdf-2","severity":"error","human":"Must have at least a name or a uri (or both)","expression":"name.exists() or uri.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.id","path":"StructureDefinition.mapping.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.mapping.extension","path":"StructureDefinition.mapping.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.mapping.modifierExtension","path":"StructureDefinition.mapping.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"StructureDefinition.mapping.identity","path":"StructureDefinition.mapping.identity","short":"Internal id when this mapping is used","definition":"An Internal id that is used to identify this mapping set when specific mappings are made.","comment":"The specification is described once, with general comments, and then specific mappings are made that reference this declaration.","min":1,"max":"1","base":{"path":"StructureDefinition.mapping.identity","min":1,"max":"1"},"type":[{"code":"id"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.uri","path":"StructureDefinition.mapping.uri","short":"Identifies what this mapping refers to","definition":"An absolute URI that identifies the specification that this mapping is expressed to.","comment":"A formal identity for the specification being mapped to helps with identifying maps consistently.","min":0,"max":"1","base":{"path":"StructureDefinition.mapping.uri","min":0,"max":"1"},"type":[{"code":"uri"}],"condition":["sdf-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.name","path":"StructureDefinition.mapping.name","short":"Names what this mapping refers to","definition":"A name for the specification that is being mapped to.","min":0,"max":"1","base":{"path":"StructureDefinition.mapping.name","min":0,"max":"1"},"type":[{"code":"string"}],"condition":["sdf-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.comment","path":"StructureDefinition.mapping.comment","short":"Versions, Issues, Scope limitations etc","definition":"Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.","min":0,"max":"1","base":{"path":"StructureDefinition.mapping.comment","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.kind","path":"StructureDefinition.kind","short":"primitive-type | complex-type | resource | logical","definition":"Defines the kind of structure that this definition is describing.","min":1,"max":"1","base":{"path":"StructureDefinition.kind","min":1,"max":"1"},"type":[{"code":"code"}],"condition":["sdf-15a","sdf-15","sdf-11","sdf-29","sdf-8","sdf-3","sdf-8a"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"StructureDefinitionKind"}],"strength":"required","description":"Defines the type of structure that a definition is describing.","valueSet":"http://hl7.org/fhir/ValueSet/structure-definition-kind|5.0.0"}},{"id":"StructureDefinition.abstract","path":"StructureDefinition.abstract","short":"Whether the structure is abstract","definition":"Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.","comment":"Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the StructureDefinition, but have children described, are anonymous concrete types that specialize Element.","min":1,"max":"1","base":{"path":"StructureDefinition.abstract","min":1,"max":"1"},"type":[{"code":"boolean"}],"condition":["sdf-4"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.context","path":"StructureDefinition.context","short":"If an extension, where it can be used in instances","definition":"Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the [defining extensions page](defining-extensions.html#context).","min":0,"max":"*","base":{"path":"StructureDefinition.context","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"condition":["sdf-5"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.context.id","path":"StructureDefinition.context.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.context.extension","path":"StructureDefinition.context.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.context.modifierExtension","path":"StructureDefinition.context.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"StructureDefinition.context.type","path":"StructureDefinition.context.type","short":"fhirpath | element | extension","definition":"Defines how to interpret the expression that defines what the context of the extension is.","min":1,"max":"1","base":{"path":"StructureDefinition.context.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ExtensionContextType"}],"strength":"required","description":"How an extension context is interpreted.","valueSet":"http://hl7.org/fhir/ValueSet/extension-context-type|5.0.0"}},{"id":"StructureDefinition.context.expression","path":"StructureDefinition.context.expression","short":"Where the extension can be used in instances","definition":"An expression that defines where an extension can be used in resources.","min":1,"max":"1","base":{"path":"StructureDefinition.context.expression","min":1,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.contextInvariant","path":"StructureDefinition.contextInvariant","short":"FHIRPath invariants - when the extension can be used","definition":"A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.","comment":"The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.","min":0,"max":"*","base":{"path":"StructureDefinition.contextInvariant","min":0,"max":"*"},"type":[{"code":"string"}],"condition":["sdf-18"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.type","path":"StructureDefinition.type","short":"Type defined or constrained by this structure","definition":"The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models, where they are required.","comment":"Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a type defining structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type SHALL be a fully specified URL, the type name SHOULD start with the final path segment of the type URL where required. E.g. If the type was \"http://example.org/fhir/MyLogicalModelType\", the type name should start with 'MyLogicalModelType'.","min":1,"max":"1","base":{"path":"StructureDefinition.type","min":1,"max":"1"},"type":[{"code":"uri"}],"condition":["sdf-18","sdf-11","sdf-5","sdf-8","sdf-8a"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FHIRTypes"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Either a resource or a data type, including logical model types.","valueSet":"http://hl7.org/fhir/ValueSet/fhir-types"}},{"id":"StructureDefinition.baseDefinition","path":"StructureDefinition.baseDefinition","short":"Definition that this type is constrained/specialized from","definition":"An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.","comment":"If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Base\", \"Element\" or another logical model.","min":0,"max":"1","base":{"path":"StructureDefinition.baseDefinition","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]}],"condition":["sdf-4","sdf-27"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.derivation","path":"StructureDefinition.derivation","short":"specialization | constraint - How relates to base definition","definition":"How the type relates to the baseDefinition.","comment":"If the definition is a specialization, then it adds to the differential new elements and optionally additional rules to an existing concrete type, and the snapshot includes the inherited elements and rules. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).","min":0,"max":"1","base":{"path":"StructureDefinition.derivation","min":0,"max":"1"},"type":[{"code":"code"}],"condition":["sdf-1","sdf-21","sdf-5","sdf-27","sdf-29"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TypeDerivationRule"}],"strength":"required","description":"How a type relates to its baseDefinition.","valueSet":"http://hl7.org/fhir/ValueSet/type-derivation-rule|5.0.0"}},{"id":"StructureDefinition.snapshot","path":"StructureDefinition.snapshot","short":"Snapshot view of the structure","definition":"A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.","min":0,"max":"1","base":{"path":"StructureDefinition.snapshot","min":0,"max":"1"},"type":[{"code":"BackboneElement"}],"condition":["sdf-11","sdf-1","sdf-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"sdf-3","severity":"error","human":"Each element definition in a snapshot must have a formal definition and cardinalities, unless model is a logical model","expression":"%resource.kind = 'logical' or element.all(definition.exists() and min.exists() and max.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-8","severity":"error","human":"All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models","expression":"(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-24","severity":"error","human":"For CodeableReference elements, target profiles must be listed on the CodeableReference, not the CodeableReference.reference","expression":"element.where(type.where(code='Reference').exists() and path.endsWith('.reference') and type.targetProfile.exists() and (path.substring(0,$this.path.length()-10) in %context.element.where(type.where(code='CodeableReference').exists()).path)).exists().not()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-25","severity":"error","human":"For CodeableReference elements, bindings must be listed on the CodeableReference, not the CodeableReference.concept","expression":"element.where(type.where(code='CodeableConcept').exists() and path.endsWith('.concept') and binding.exists() and (path.substring(0,$this.path.length()-8) in %context.element.where(type.where(code='CodeableReference').exists()).path)).exists().not()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"It is bad practice to set the root element of a profile to 'mustSupport' as mustSupport should always be determined by the element referencing a type. The designer of a StructureDefinition cannot know all circumstances in which a type or profile might be used"}],"key":"sdf-26","severity":"warning","human":"The root element of a profile should not have mustSupport = true","expression":"$this.where(element[0].mustSupport='true').exists().not()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-8b","severity":"error","human":"All snapshot elements must have a base definition","expression":"element.all(base.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.snapshot.id","path":"StructureDefinition.snapshot.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.snapshot.extension","path":"StructureDefinition.snapshot.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.snapshot.modifierExtension","path":"StructureDefinition.snapshot.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"StructureDefinition.snapshot.element","path":"StructureDefinition.snapshot.element","short":"Definition of elements in the resource (if no StructureDefinition)","definition":"Captures constraints on each element within the resource.","min":1,"max":"*","base":{"path":"StructureDefinition.snapshot.element","min":1,"max":"*"},"type":[{"code":"ElementDefinition"}],"condition":["sdf-9","sdf-19","sdf-16","sdf-15","sdf-23","sdf-11","sdf-22","sdf-14","sdf-1","sdf-8","sdf-3","sdf-8b","sdf-24","sdf-25","sdf-26"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"sdf-10","requirements":"binding is required","severity":"error","human":"provide either a binding reference or a description (or both)","expression":"binding.empty() or binding.valueSet.exists() or binding.description.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-28","severity":"error","human":"If there are no discriminators, there must be a definition","expression":"slicing.exists().not() or (slicing.discriminator.exists() or slicing.description.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"iso11179","map":"--"}]},{"id":"StructureDefinition.differential","path":"StructureDefinition.differential","short":"Differential view of the structure","definition":"A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.","min":0,"max":"1","base":{"path":"StructureDefinition.differential","min":0,"max":"1"},"type":[{"code":"BackboneElement"}],"condition":["sdf-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"sdf-20","requirements":"no slicing on root","severity":"error","human":"No slicing on the root element","expression":"element.where(path.contains('.').not()).slicing.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-8a","severity":"error","human":"In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models","expression":"(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\\\..*','')&'.')))","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.differential.id","path":"StructureDefinition.differential.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.differential.extension","path":"StructureDefinition.differential.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.differential.modifierExtension","path":"StructureDefinition.differential.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"StructureDefinition.differential.element","path":"StructureDefinition.differential.element","short":"Definition of elements in the resource (if no StructureDefinition)","definition":"Captures constraints on each element within the resource.","min":1,"max":"*","base":{"path":"StructureDefinition.differential.element","min":1,"max":"*"},"type":[{"code":"ElementDefinition"}],"condition":["sdf-9","sdf-15a","sdf-19","sdf-17","sdf-23","sdf-22","sdf-14","sdf-21","sdf-29","sdf-20","sdf-8a"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"iso11179","map":"--"}]}]},"differential":{"element":[{"id":"StructureDefinition","path":"StructureDefinition","short":"Structural Definition","definition":"A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.","alias":["Template","Profile"],"min":0,"max":"*","constraint":[{"key":"cnl-0","severity":"warning","human":"Name should be usable as an identifier for the module by machine processing applications such as code generation","expression":"name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-9","requirements":"Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition","severity":"error","human":"In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)","expression":"children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-15a","requirements":"No Type on the root element (differential)","severity":"error","human":"If the first element in a differential has no \".\" in the path and it's not a logical model, it has no type","expression":"(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-19","requirements":"custom types only in logical models","severity":"error","human":"FHIR Specification models only use FHIR defined types","expression":"url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential | snapshot).element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$'))","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-16","requirements":"element ids need to be unique","severity":"error","human":"All element definitions must have unique ids (snapshot)","expression":"snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-27","severity":"error","human":"If there's a base definition, there must be a derivation ","expression":"baseDefinition.exists() implies derivation.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-15","requirements":"No Type on the root element (snapshot)","severity":"error","human":"The first element in a snapshot has no type unless model is a logical model.","expression":"kind!='logical' implies snapshot.element.first().type.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-18","requirements":"contextInvariant","severity":"error","human":"Context Invariants can only be used for extensions","expression":"contextInvariant.exists() implies type = 'Extension'","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-29","severity":"warning","human":"Elements in Resources must have a min cardinality or 0 or 1 and a max cardinality of 1 or *","expression":"((kind in 'resource' | 'complex-type') and (derivation = 'specialization')) implies differential.element.where((min != 0 and min != 1) or (max != '1' and max != '*')).empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-17","requirements":"element ids need to be unique","severity":"error","human":"All element definitions must have unique ids (diff)","expression":"differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-23","requirements":"no sliceName on root","severity":"error","human":"No slice name on root","expression":"(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-11","requirements":"Ensure that the type is not inconsistent with the other information in the structure","severity":"error","human":"If there's a type, its content must match the path name in the first element of a snapshot","expression":"kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-22","requirements":"no default values on data types or resources","severity":"error","human":"FHIR Specification models never have default values","expression":"url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-14","requirements":"elements have id","severity":"error","human":"All element definitions must have an id","expression":"snapshot.element.all(id.exists()) and differential.element.all(id.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-1","severity":"error","human":"Element paths must be unique unless the structure is a constraint","expression":"derivation = 'constraint' or snapshot.element.select(path).isDistinct()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-21","requirements":"no default values on data types or resources","severity":"error","human":"Default values can only be specified on specializations","expression":"differential.element.defaultValue.exists() implies (derivation = 'specialization')","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-6","severity":"error","human":"A structure must have either a differential, or a snapshot (or both)","expression":"snapshot.exists() or differential.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-5","severity":"error","human":"If the structure defines an extension then the structure must have context information","expression":"type != 'Extension' or derivation = 'specialization' or (context.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-4","requirements":"Ensure that the base types are abstract","severity":"error","human":"If the structure is not abstract, then there SHALL be a baseDefinition","expression":"abstract = true or baseDefinition.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"mapping":[{"identity":"w5","map":"conformance.content"},{"identity":"rim","map":"n/a"}]},{"id":"StructureDefinition.url","path":"StructureDefinition.url","short":"Canonical identifier for this structure definition, represented as a URI (globally unique)","definition":"An absolute URI that is used to identify this structure 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 an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.","comment":"Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.","requirements":"Allows the structure definition to be referenced by a single globally unique identifier.","alias":["url","authoritative-url","destination","identity"],"min":1,"max":"1","type":[{"code":"uri"}],"condition":["sdf-19","sdf-22"],"constraint":[{"key":"cnl-1","severity":"warning","human":"URL should not contain | or # - these characters make processing canonical references problematic","expression":"exists() implies matches('^[^|# ]+$')","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"}]},{"id":"StructureDefinition.identifier","path":"StructureDefinition.identifier","short":"Additional identifier for the structure definition","definition":"A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.","comment":"Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.","requirements":"Allows externally provided and/or usable business identifiers to be easily associated with the module.","min":0,"max":"*","type":[{"code":"Identifier"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"iso11179","map":"Identifier part"},{"identity":"objimpl","map":"no-gen-base"}]},{"id":"StructureDefinition.version","path":"StructureDefinition.version","short":"Business version of the structure definition","definition":"The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. There is no expectation that versions can be placed in a lexicographical sequence, so authors are encouraged to populate the StructureDefinition.versionAlgorithm[x] element to enable comparisons. If there is no managed version available, authors can consider using ISO date/time syntax (e.g., '2023-01-01').","comment":"There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.version"},{"identity":"iso11179","map":"Version"}]},{"id":"StructureDefinition.versionAlgorithm[x]","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"StructureDefinition.versionAlgorithm[x]","short":"How to compare versions","definition":"Indicates the mechanism used to compare versions to determine which is more current.","comment":"If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.","min":0,"max":"1","type":[{"code":"string"},{"code":"Coding"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/version-algorithm"}},{"id":"StructureDefinition.name","path":"StructureDefinition.name","short":"Name for this structure definition (computer friendly)","definition":"A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.","comment":"The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.Some Examples: \n\n* O2SatObservation\n* PresentationReport\n* Immunization2\n* AcmeAdmissionRecordOld.","requirements":"Support human navigation and code generation.","min":1,"max":"1","type":[{"code":"string"}],"condition":["cnl-0"],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.title","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.title","short":"Name for this structure definition (human friendly)","definition":"A short, descriptive, user-friendly title for the structure definition.","comment":"This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.status","path":"StructureDefinition.status","short":"draft | active | retired | unknown","definition":"The status of this structure definition. Enables tracking the life-cycle of the content.","comment":"Allows filtering of structure definitions that are appropriate for use versus not.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"PublicationStatus"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"The lifecycle status of an artifact.","valueSet":"http://hl7.org/fhir/ValueSet/publication-status|5.0.0"},"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"iso11179","map":"Registration status"}]},{"id":"StructureDefinition.experimental","path":"StructureDefinition.experimental","short":"For testing purposes, not real usage","definition":"A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.","comment":"Allows filtering of structure definitions that are appropriate for use versus not.","requirements":"Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.","min":0,"max":"1","type":[{"code":"boolean"}],"meaningWhenMissing":"If absent, this resource is treated as though it is not experimental.","mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"iso11179","map":"Registration status"}]},{"id":"StructureDefinition.date","path":"StructureDefinition.date","short":"Date last changed","definition":"The date (and optionally time) when the structure definition was last significantly changed. 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 structure definition changes.","comment":"The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).","alias":["Revision Date"],"min":0,"max":"1","type":[{"code":"dateTime"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"}]},{"id":"StructureDefinition.publisher","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.publisher","short":"Name of the publisher/steward (organization or individual)","definition":"The name of the organization or individual responsible for the release and ongoing maintenance of the structure definition.","comment":"Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.","requirements":"Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.witness"},{"identity":"iso11179","map":"Registration Authority"}]},{"id":"StructureDefinition.contact","path":"StructureDefinition.contact","short":"Contact details for the publisher","definition":"Contact details to assist a user in finding and communicating with the publisher.","comment":"May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).","min":0,"max":"*","type":[{"code":"ContactDetail"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.description","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.description","short":"Natural language description of the structure definition","definition":"A free text natural language description of the structure definition from a consumer's perspective.","comment":"This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure definition is presumed to be the predominant language in the place the structure definition was created).","min":0,"max":"1","type":[{"code":"markdown"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.useContext","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"StructureDefinition.useContext","short":"The context that the content is intended to support","definition":"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 structure definition instances.","comment":"When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.","requirements":"Assist in searching for appropriate content.","min":0,"max":"*","type":[{"code":"UsageContext"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.jurisdiction","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"deprecated"}],"path":"StructureDefinition.jurisdiction","short":"Intended jurisdiction for structure definition (if applicable)","definition":"A legal or geographic region in which the structure definition is intended to be used.","comment":"It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)","min":0,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Jurisdiction"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Countries and regions within which this artifact is targeted for use.","valueSet":"http://hl7.org/fhir/ValueSet/jurisdiction"}},{"id":"StructureDefinition.purpose","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.purpose","short":"Why this structure definition is defined","definition":"Explanation of why this structure definition is needed and why it has been designed as it has.","comment":"This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.","min":0,"max":"1","type":[{"code":"markdown"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"objimpl","map":"no-gen-base"}]},{"id":"StructureDefinition.copyright","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.copyright","short":"Use and/or publishing restrictions","definition":"A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.","comment":"...","requirements":"Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.","alias":["License","Restrictions"],"min":0,"max":"1","type":[{"code":"markdown"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"objimpl","map":"no-gen-base"}]},{"id":"StructureDefinition.copyrightLabel","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"StructureDefinition.copyrightLabel","short":"Copyright holder and year(s)","definition":"A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').","comment":"The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.","requirements":"Defines the content expected to be rendered in all representations of the artifact.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.keyword","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"deprecated"}],"path":"StructureDefinition.keyword","short":"Assist with indexing and finding","definition":"(DEPRECATED) A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.","comment":"Note that this element is deprecated. Use the [http://hl7.org/fhir/StructureDefinition/artifact-topic](http://hl7.org/fhir/extensions/StructureDefinition-artifact-topic.html) extension instead.","requirements":"Assist in searching for appropriate StructureDefinitions.","min":0,"max":"*","type":[{"code":"Coding"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"StructureDefinitionKeyword"}],"strength":"extensible","description":"Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).","valueSet":"http://hl7.org/fhir/ValueSet/definition-use"},"mapping":[{"identity":"iso11179","map":"keywords"}]},{"id":"StructureDefinition.fhirVersion","path":"StructureDefinition.fhirVersion","short":"FHIR Version this StructureDefinition targets","definition":"The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.","comment":"A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.","min":0,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FHIRVersion"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"All published FHIR Versions.","valueSet":"http://hl7.org/fhir/ValueSet/FHIR-version|5.0.0"}},{"id":"StructureDefinition.mapping","path":"StructureDefinition.mapping","short":"External specification that the content is mapped to","definition":"An external specification that the content is mapped to.","min":0,"max":"*","type":[{"code":"BackboneElement"}],"constraint":[{"key":"sdf-2","severity":"error","human":"Must have at least a name or a uri (or both)","expression":"name.exists() or uri.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.identity","path":"StructureDefinition.mapping.identity","short":"Internal id when this mapping is used","definition":"An Internal id that is used to identify this mapping set when specific mappings are made.","comment":"The specification is described once, with general comments, and then specific mappings are made that reference this declaration.","min":1,"max":"1","type":[{"code":"id"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.uri","path":"StructureDefinition.mapping.uri","short":"Identifies what this mapping refers to","definition":"An absolute URI that identifies the specification that this mapping is expressed to.","comment":"A formal identity for the specification being mapped to helps with identifying maps consistently.","min":0,"max":"1","type":[{"code":"uri"}],"condition":["sdf-2"],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.name","path":"StructureDefinition.mapping.name","short":"Names what this mapping refers to","definition":"A name for the specification that is being mapped to.","min":0,"max":"1","type":[{"code":"string"}],"condition":["sdf-2"],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.mapping.comment","path":"StructureDefinition.mapping.comment","short":"Versions, Issues, Scope limitations etc","definition":"Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.","min":0,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.kind","path":"StructureDefinition.kind","short":"primitive-type | complex-type | resource | logical","definition":"Defines the kind of structure that this definition is describing.","min":1,"max":"1","type":[{"code":"code"}],"condition":["sdf-15a","sdf-15","sdf-11","sdf-29","sdf-8","sdf-3","sdf-8a"],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"StructureDefinitionKind"}],"strength":"required","description":"Defines the type of structure that a definition is describing.","valueSet":"http://hl7.org/fhir/ValueSet/structure-definition-kind|5.0.0"}},{"id":"StructureDefinition.abstract","path":"StructureDefinition.abstract","short":"Whether the structure is abstract","definition":"Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.","comment":"Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the StructureDefinition, but have children described, are anonymous concrete types that specialize Element.","min":1,"max":"1","type":[{"code":"boolean"}],"condition":["sdf-4"],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.context","path":"StructureDefinition.context","short":"If an extension, where it can be used in instances","definition":"Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the [defining extensions page](defining-extensions.html#context).","min":0,"max":"*","type":[{"code":"BackboneElement"}],"condition":["sdf-5"],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.context.type","path":"StructureDefinition.context.type","short":"fhirpath | element | extension","definition":"Defines how to interpret the expression that defines what the context of the extension is.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ExtensionContextType"}],"strength":"required","description":"How an extension context is interpreted.","valueSet":"http://hl7.org/fhir/ValueSet/extension-context-type|5.0.0"}},{"id":"StructureDefinition.context.expression","path":"StructureDefinition.context.expression","short":"Where the extension can be used in instances","definition":"An expression that defines where an extension can be used in resources.","min":1,"max":"1","type":[{"code":"string"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.contextInvariant","path":"StructureDefinition.contextInvariant","short":"FHIRPath invariants - when the extension can be used","definition":"A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.","comment":"The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.","min":0,"max":"*","type":[{"code":"string"}],"condition":["sdf-18"],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.type","path":"StructureDefinition.type","short":"Type defined or constrained by this structure","definition":"The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models, where they are required.","comment":"Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a type defining structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type SHALL be a fully specified URL, the type name SHOULD start with the final path segment of the type URL where required. E.g. If the type was \"http://example.org/fhir/MyLogicalModelType\", the type name should start with 'MyLogicalModelType'.","min":1,"max":"1","type":[{"code":"uri"}],"condition":["sdf-18","sdf-11","sdf-5","sdf-8","sdf-8a"],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FHIRTypes"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Either a resource or a data type, including logical model types.","valueSet":"http://hl7.org/fhir/ValueSet/fhir-types"}},{"id":"StructureDefinition.baseDefinition","path":"StructureDefinition.baseDefinition","short":"Definition that this type is constrained/specialized from","definition":"An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.","comment":"If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Base\", \"Element\" or another logical model.","min":0,"max":"1","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy","valueBoolean":true}],"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]}],"condition":["sdf-4","sdf-27"],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"StructureDefinition.derivation","path":"StructureDefinition.derivation","short":"specialization | constraint - How relates to base definition","definition":"How the type relates to the baseDefinition.","comment":"If the definition is a specialization, then it adds to the differential new elements and optionally additional rules to an existing concrete type, and the snapshot includes the inherited elements and rules. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).","min":0,"max":"1","type":[{"code":"code"}],"condition":["sdf-1","sdf-21","sdf-5","sdf-27","sdf-29"],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TypeDerivationRule"}],"strength":"required","description":"How a type relates to its baseDefinition.","valueSet":"http://hl7.org/fhir/ValueSet/type-derivation-rule|5.0.0"}},{"id":"StructureDefinition.snapshot","path":"StructureDefinition.snapshot","short":"Snapshot view of the structure","definition":"A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.","min":0,"max":"1","type":[{"code":"BackboneElement"}],"condition":["sdf-11","sdf-1","sdf-6"],"constraint":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"It is bad practice to set the root element of a profile to 'mustSupport' as mustSupport should always be determined by the element referencing a type. The designer of a StructureDefinition cannot know all circumstances in which a type or profile might be used"}],"key":"sdf-26","severity":"warning","human":"The root element of a profile should not have mustSupport = true","expression":"$this.where(element[0].mustSupport='true').exists().not()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-8","severity":"error","human":"All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models","expression":"(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-25","severity":"error","human":"For CodeableReference elements, bindings must be listed on the CodeableReference, not the CodeableReference.concept","expression":"element.where(type.where(code='CodeableConcept').exists() and path.endsWith('.concept') and binding.exists() and (path.substring(0,$this.path.length()-8) in %context.element.where(type.where(code='CodeableReference').exists()).path)).exists().not()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-24","severity":"error","human":"For CodeableReference elements, target profiles must be listed on the CodeableReference, not the CodeableReference.reference","expression":"element.where(type.where(code='Reference').exists() and path.endsWith('.reference') and type.targetProfile.exists() and (path.substring(0,$this.path.length()-10) in %context.element.where(type.where(code='CodeableReference').exists()).path)).exists().not()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-3","severity":"error","human":"Each element definition in a snapshot must have a formal definition and cardinalities, unless model is a logical model","expression":"%resource.kind = 'logical' or element.all(definition.exists() and min.exists() and max.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-8b","severity":"error","human":"All snapshot elements must have a base definition","expression":"element.all(base.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.snapshot.element","path":"StructureDefinition.snapshot.element","short":"Definition of elements in the resource (if no StructureDefinition)","definition":"Captures constraints on each element within the resource.","min":1,"max":"*","type":[{"code":"ElementDefinition"}],"condition":["sdf-9","sdf-19","sdf-16","sdf-15","sdf-23","sdf-11","sdf-22","sdf-14","sdf-1","sdf-8","sdf-3","sdf-8b","sdf-24","sdf-25","sdf-26"],"constraint":[{"key":"sdf-28","severity":"error","human":"If there are no discriminators, there must be a definition","expression":"slicing.exists().not() or (slicing.discriminator.exists() or slicing.description.exists())","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-10","requirements":"binding is required","severity":"error","human":"provide either a binding reference or a description (or both)","expression":"binding.empty() or binding.valueSet.exists() or binding.description.exists()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"iso11179","map":"--"}]},{"id":"StructureDefinition.differential","path":"StructureDefinition.differential","short":"Differential view of the structure","definition":"A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.","min":0,"max":"1","type":[{"code":"BackboneElement"}],"condition":["sdf-6"],"constraint":[{"key":"sdf-20","requirements":"no slicing on root","severity":"error","human":"No slicing on the root element","expression":"element.where(path.contains('.').not()).slicing.empty()","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"},{"key":"sdf-8a","severity":"error","human":"In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models","expression":"(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\\\..*','')&'.')))","source":"http://hl7.org/fhir/StructureDefinition/StructureDefinition"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"StructureDefinition.differential.element","path":"StructureDefinition.differential.element","short":"Definition of elements in the resource (if no StructureDefinition)","definition":"Captures constraints on each element within the resource.","min":1,"max":"*","type":[{"code":"ElementDefinition"}],"condition":["sdf-9","sdf-15a","sdf-19","sdf-17","sdf-23","sdf-22","sdf-14","sdf-21","sdf-29","sdf-20","sdf-8a"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"iso11179","map":"--"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-actualgroup.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-actualgroup.json index 136179c47..496fc85e7 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-actualgroup.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-actualgroup.json @@ -1,1287 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "actualgroup", - "text" : { - "status" : "generated", - "div" : "
to do
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 0 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "fhir" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/actualgroup", - "version" : "4.6.0", - "name" : "Actual Group", - "status" : "draft", - "experimental" : false, - "date" : "2020-12-28T16:55:11+11:00", - "publisher" : "HL7", - "description" : "Enforces an actual group, rather than a definitional group", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "interface", - "uri" : "http://hl7.org/fhir/interface", - "name" : "Interface Pattern" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }], - "kind" : "resource", - "abstract" : false, - "type" : "Group", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Group", - "derivation" : "constraint", - "snapshot" : { - "element" : [{ - "id" : "Group", - "path" : "Group", - "short" : "Group of multiple entities", - "definition" : "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.", - "comment" : "If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group", - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "grp-1", - "severity" : "error", - "human" : "Can only have members if group is \"actual\"", - "expression" : "member.empty() or (actual = true)", - "xpath" : "f:actual/@value=true() or not(exists(f:member))", - "source" : "http://hl7.org/fhir/StructureDefinition/Group" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "rim", - "map" : "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]" - }, - { - "identity" : "interface", - "map" : "Participant" - }, - { - "identity" : "w5", - "map" : "administrative.group" - }] - }, - { - "id" : "Group.id", - "path" : "Group.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Group.meta", - "path" : "Group.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Group.implicitRules", - "path" : "Group.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "Group.language", - "path" : "Group.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "Group.text", - "path" : "Group.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "Group.contained", - "path" : "Group.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.extension", - "path" : "Group.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.modifierExtension", - "path" : "Group.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.identifier", - "path" : "Group.identifier", - "short" : "Unique id", - "definition" : "A unique business identifier for this group.", - "requirements" : "Allows the group to be referenced from external specifications.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Group.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "rim", - "map" : "unique(./id[displayable=\"true\" and scope=\"OBJ\"])" - }, - { - "identity" : "interface", - "map" : "Participant.identifier" - }] - }, - { - "id" : "Group.active", - "path" : "Group.active", - "short" : "Whether this group's record is in active use", - "definition" : "Indicates whether the record for the group is available for use or is merely being retained for historical purposes.", - "requirements" : "Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.active", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "rim", - "map" : "./statusCode" - }, - { - "identity" : "interface", - "map" : "Participant.active" - }] - }, - { - "id" : "Group.type", - "path" : "Group.type", - "short" : "person | animal | practitioner | device | medication | substance", - "definition" : "Identifies the broad classification of the kind of resources the group includes.", - "comment" : "Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).", - "requirements" : "Identifies what type of resources the group is made up of.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.type", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupType" - }], - "strength" : "required", - "description" : "Types of resources that are part of group.", - "valueSet" : "http://hl7.org/fhir/ValueSet/group-type|4.6.0" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\"" - }] - }, - { - "id" : "Group.actual", - "path" : "Group.actual", - "short" : "Descriptive or actual", - "definition" : "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.", - "requirements" : "There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.actual", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "fixedBoolean" : true, - "condition" : ["grp-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : "true: ./determinerCode=\"GRP\" false: ./determinerCode=\"GRP_KIND\"" - }] - }, - { - "id" : "Group.code", - "path" : "Group.code", - "short" : "Kind of Group members", - "definition" : "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.", - "comment" : "This would generally be omitted for Person resources.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupKind" - }], - "strength" : "example", - "description" : "Kind of particular resource; e.g. cow, syringe, lake, etc." - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "rim", - "map" : "./code" - }] - }, - { - "id" : "Group.name", - "path" : "Group.name", - "short" : "Label for Group", - "definition" : "A label assigned to the group for human identification and communication.", - "requirements" : "Used to identify the group in human communication.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.name", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "./name[type=\"ST\"]" - }, - { - "identity" : "interface", - "map" : "Participant.name" - }] - }, - { - "id" : "Group.quantity", - "path" : "Group.quantity", - "short" : "Number of members", - "definition" : "A count of the number of resource instances that are part of the group.", - "comment" : "Note that the quantity may be less than the number of members if some of the members are not active.", - "requirements" : "Group size is a common defining characteristic.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.quantity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "unsignedInt" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "./quantity" - }] - }, - { - "id" : "Group.managingEntity", - "path" : "Group.managingEntity", - "short" : "Entity that is the custodian of the Group's definition", - "definition" : "Entity responsible for defining and maintaining Group characteristics and/or registered members.", - "comment" : "This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.managingEntity", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Group.characteristic", - "path" : "Group.characteristic", - "short" : "Include / Exclude group members by Trait", - "definition" : "Identifies traits whose presence r absence is shared by members of the group.", - "comment" : "All the identified characteristics must be true for an entity to a member of the group.", - "requirements" : "Needs to be a generic mechanism for identifying what individuals can be part of a group.", - "min" : 0, - "max" : "0", - "base" : { - "path" : "Group.characteristic", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]" - }] - }, - { - "id" : "Group.characteristic.id", - "path" : "Group.characteristic.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.characteristic.extension", - "path" : "Group.characteristic.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.characteristic.modifierExtension", - "path" : "Group.characteristic.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.characteristic.code", - "path" : "Group.characteristic.code", - "short" : "Kind of characteristic", - "definition" : "A code that identifies the kind of trait being asserted.", - "requirements" : "Need a formal way of identifying the characteristic being described.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.characteristic.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupCharacteristicKind" - }], - "strength" : "example", - "description" : "List of characteristics used to describe group members; e.g. gender, age, owner, location, etc." - }, - "mapping" : [{ - "identity" : "rim", - "map" : "./code" - }] - }, - { - "id" : "Group.characteristic.value[x]", - "path" : "Group.characteristic.value[x]", - "short" : "Value held by characteristic", - "definition" : "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.", - "comment" : "For Range, it means members of the group have a value that falls somewhere within the specified range.", - "requirements" : "The value of the characteristic is what determines group membership.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.characteristic.value[x]", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }, - { - "code" : "boolean" - }, - { - "code" : "Quantity" - }, - { - "code" : "Range" - }, - { - "code" : "Reference" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "GroupCharacteristicValue" - }], - "strength" : "example", - "description" : "Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc." - }, - "mapping" : [{ - "identity" : "rim", - "map" : "./value" - }] - }, - { - "id" : "Group.characteristic.exclude", - "path" : "Group.characteristic.exclude", - "short" : "Group includes or excludes", - "definition" : "If true, indicates the characteristic is one that is NOT held by members of the group.", - "comment" : "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.", - "requirements" : "Sometimes group membership is determined by characteristics not possessed.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.characteristic.exclude", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./valueNegationInd" - }] - }, - { - "id" : "Group.characteristic.period", - "path" : "Group.characteristic.period", - "short" : "Period over which characteristic is tested", - "definition" : "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.characteristic.period", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Period" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member", - "path" : "Group.member", - "short" : "Who or what is in group", - "definition" : "Identifies the resource instances that are members of the group.", - "requirements" : "Often the only thing of interest about a group is \"who's in it\".", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Group.member", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "condition" : ["grp-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player" - }] - }, - { - "id" : "Group.member.id", - "path" : "Group.member.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.member.extension", - "path" : "Group.member.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Group.member.modifierExtension", - "path" : "Group.member.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Group.member.entity", - "path" : "Group.member.entity", - "short" : "Reference to the group member", - "definition" : "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.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Group.member.entity", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/Medication", - "http://hl7.org/fhir/StructureDefinition/Substance", - "http://hl7.org/fhir/StructureDefinition/Group"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member.period", - "path" : "Group.member.period", - "short" : "Period member belonged to the group", - "definition" : "The period that the member was in the group, if known.", - "requirements" : "Need to track who was in a group at a particular time.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.member.period", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Period" - }], - "meaningWhenMissing" : "The member is in the group at this time", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "Group.member.inactive", - "path" : "Group.member.inactive", - "short" : "If member is no longer in group", - "definition" : "A flag to indicate that the member is no longer in the group, but previously may have been a member.", - "requirements" : "Sometimes you don't know when someone stopped being in a group, but not when.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Group.member.inactive", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "meaningWhenMissing" : "Members are considered active unless explicitly specified otherwise", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false - }] - }, - "differential" : { - "element" : [{ - "id" : "Group", - "path" : "Group", - "min" : 1, - "max" : "1" - }, - { - "id" : "Group.actual", - "path" : "Group.actual", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "boolean" - }], - "fixedBoolean" : true - }, - { - "id" : "Group.characteristic", - "path" : "Group.characteristic", - "min" : 0, - "max" : "0" - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"actualgroup","text":{"status":"generated","div":"
to do
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":0},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"url":"http://hl7.org/fhir/StructureDefinition/actualgroup","identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:2.16.840.1.113883.4.642.5.1090"}],"version":"5.0.0","name":"ActualGroup","title":"Actual Group","status":"draft","experimental":false,"date":"2020-12-28T16:55:11+11:00","publisher":"HL7","description":"Enforces an enumerated group, rather than a definitional group","fhirVersion":"5.0.0","mapping":[{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"interface","uri":"http://hl7.org/fhir/interface","name":"Interface Pattern"},{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"}],"kind":"resource","abstract":false,"type":"Group","baseDefinition":"http://hl7.org/fhir/StructureDefinition/Group","derivation":"constraint","snapshot":{"element":[{"id":"Group","path":"Group","short":"Group of multiple entities","definition":"Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.","comment":"If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.","min":1,"max":"1","base":{"path":"Group","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"},{"identity":"w5","map":"administrative.group"},{"identity":"interface","map":"Participant"}]},{"id":"Group.id","path":"Group.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Group.meta","path":"Group.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Group.implicitRules","path":"Group.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Group.language","path":"Group.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Group.text","path":"Group.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Group.contained","path":"Group.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.extension","path":"Group.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.modifierExtension","path":"Group.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.identifier","path":"Group.identifier","short":"Business Identifier for this Group","definition":"Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.","comment":"Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.","requirements":"Allows identification of the group as it is known by various participating systems and in a way that remains consistent across servers.","min":0,"max":"*","base":{"path":"Group.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.identifier"},{"identity":"rim","map":"unique(./id[displayable=\"true\" and scope=\"OBJ\"])"},{"identity":"interface","map":"Participant.identifier"}]},{"id":"Group.active","path":"Group.active","short":"Whether this group's record is in active use","definition":"Indicates whether the record for the group is available for use or is merely being retained for historical purposes.","requirements":"Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).","min":0,"max":"1","base":{"path":"Group.active","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"This resource is generally assumed to be active if no value is provided for the active element","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.status"},{"identity":"rim","map":"./statusCode"},{"identity":"interface","map":"Participant.active"}]},{"id":"Group.type","path":"Group.type","short":"person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen","definition":"Identifies the broad classification of the kind of resources the group includes.","comment":"Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type.","requirements":"Identifies what type of resources the group is made up of.","min":1,"max":"1","base":{"path":"Group.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupType"}],"strength":"required","description":"Types of resources that are part of group.","valueSet":"http://hl7.org/fhir/ValueSet/group-type|5.0.0"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":"person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\""}]},{"id":"Group.membership","path":"Group.membership","short":"definitional | enumerated","definition":"Basis for membership in the Group:\n\n* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.\n* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.","requirements":"There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this element.","min":1,"max":"1","base":{"path":"Group.membership","min":1,"max":"1"},"type":[{"code":"code"}],"fixedCode":"enumerated","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"strength":"required","description":"The basis for membership in a group","valueSet":"http://hl7.org/fhir/ValueSet/group-membership-basis|5.0.0"}},{"id":"Group.code","path":"Group.code","short":"Kind of Group members","definition":"Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.","comment":"This would generally be omitted for Person resources.","min":0,"max":"1","base":{"path":"Group.code","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupKind"}],"strength":"example","description":"Kind of particular resource; e.g. cow, syringe, lake, etc."},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"rim","map":"./code"}]},{"id":"Group.name","path":"Group.name","short":"Label for Group","definition":"A label assigned to the group for human identification and communication.","requirements":"Used to identify the group in human communication.","min":0,"max":"1","base":{"path":"Group.name","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./name[type=\"ST\"]"},{"identity":"interface","map":"Participant.name"}]},{"id":"Group.description","path":"Group.description","short":"Natural language description of the group","definition":"Explanation of what the group represents and how it is intended to be used.","min":0,"max":"1","base":{"path":"Group.description","min":0,"max":"1"},"type":[{"code":"markdown"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.quantity","path":"Group.quantity","short":"Number of members","definition":"A count of the number of resource instances that are part of the group.","comment":"Note that the quantity may be less than the number of members if some of the members are not active.","requirements":"Group size is a common defining characteristic.","min":0,"max":"1","base":{"path":"Group.quantity","min":0,"max":"1"},"type":[{"code":"unsignedInt"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./quantity"}]},{"id":"Group.managingEntity","path":"Group.managingEntity","short":"Entity that is the custodian of the Group's definition","definition":"Entity responsible for defining and maintaining Group characteristics and/or registered members.","comment":"This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.","min":0,"max":"1","base":{"path":"Group.managingEntity","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.witness"}]},{"id":"Group.characteristic","path":"Group.characteristic","short":"Include / Exclude group members by Trait","definition":"Identifies traits whose presence r absence is shared by members of the group.","comment":"All the identified characteristics must be true for an entity to a member of the group.","requirements":"Needs to be a generic mechanism for identifying what individuals can be part of a group.","min":0,"max":"*","base":{"path":"Group.characteristic","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"}]},{"id":"Group.characteristic.id","path":"Group.characteristic.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.characteristic.extension","path":"Group.characteristic.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.characteristic.modifierExtension","path":"Group.characteristic.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.characteristic.code","path":"Group.characteristic.code","short":"Kind of characteristic","definition":"A code that identifies the kind of trait being asserted.","requirements":"Need a formal way of identifying the characteristic being described.","min":1,"max":"1","base":{"path":"Group.characteristic.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupCharacteristicKind"}],"strength":"example","description":"List of characteristics used to describe group members; e.g. gender, age, owner, location, etc."},"mapping":[{"identity":"rim","map":"./code"}]},{"id":"Group.characteristic.value[x]","path":"Group.characteristic.value[x]","short":"Value held by characteristic","definition":"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.","comment":"For Range, it means members of the group have a value that falls somewhere within the specified range.","requirements":"The value of the characteristic is what determines group membership.","min":1,"max":"1","base":{"path":"Group.characteristic.value[x]","min":1,"max":"1"},"type":[{"code":"CodeableConcept"},{"code":"boolean"},{"code":"Quantity"},{"code":"Range"},{"code":"Reference"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"GroupCharacteristicValue"}],"strength":"example","description":"Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc."},"mapping":[{"identity":"rim","map":"./value"}]},{"id":"Group.characteristic.exclude","path":"Group.characteristic.exclude","short":"Group includes or excludes","definition":"If true, indicates the characteristic is one that is NOT held by members of the group.","comment":"This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.","requirements":"Sometimes group membership is determined by characteristics not possessed.","min":1,"max":"1","base":{"path":"Group.characteristic.exclude","min":1,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"./valueNegationInd"}]},{"id":"Group.characteristic.period","path":"Group.characteristic.period","short":"Period over which characteristic is tested","definition":"The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.","min":0,"max":"1","base":{"path":"Group.characteristic.period","min":0,"max":"1"},"type":[{"code":"Period"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member","path":"Group.member","short":"Who or what is in group","definition":"Identifies the resource instances that are members of the group.","requirements":"Often the only thing of interest about a group is \"who's in it\".","min":0,"max":"*","base":{"path":"Group.member","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"rim","map":"./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"}]},{"id":"Group.member.id","path":"Group.member.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.member.extension","path":"Group.member.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Group.member.modifierExtension","path":"Group.member.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Group.member.entity","path":"Group.member.entity","short":"Reference to the group member","definition":"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.","min":1,"max":"1","base":{"path":"Group.member.entity","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Group","http://hl7.org/fhir/StructureDefinition/HealthcareService","http://hl7.org/fhir/StructureDefinition/Location","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson","http://hl7.org/fhir/StructureDefinition/Specimen"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member.period","path":"Group.member.period","short":"Period member belonged to the group","definition":"The period that the member was in the group, if known.","requirements":"Need to track who was in a group at a particular time.","min":0,"max":"1","base":{"path":"Group.member.period","min":0,"max":"1"},"type":[{"code":"Period"}],"meaningWhenMissing":"The member is in the group at this time","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false},{"id":"Group.member.inactive","path":"Group.member.inactive","short":"If member is no longer in group","definition":"A flag to indicate that the member is no longer in the group, but previously may have been a member.","requirements":"Sometimes you don't know when someone stopped being in a group, but not when.","min":0,"max":"1","base":{"path":"Group.member.inactive","min":0,"max":"1"},"type":[{"code":"boolean"}],"meaningWhenMissing":"Members are considered active unless explicitly specified otherwise","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false}]},"differential":{"element":[{"id":"Group","path":"Group","min":1,"max":"1"},{"id":"Group.membership","path":"Group.membership","min":1,"max":"1","type":[{"code":"code"}],"fixedCode":"enumerated"}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyheight.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyheight.json index ea40d3d64..e94bc7f20 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyheight.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyheight.json @@ -1,3930 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "bodyheight", - "text" : { - "status" : "generated", - "div" : "
to do
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary", - "valueMarkdown" : "#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'8302-2'**\r - 8306-3 -Body height - lying (i.e., body length - typically used for infants) MAY be included as an additional observation code - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have an system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'cm', or '[in_i]'**" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 5 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "oo" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }, - { - "url" : "http://hl7.org/fhir/build/StructureDefinition/summary", - "valueString" : "#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'8302-2'**\r - 8306-3 -Body height - lying (i.e., body length - typically used for infants) MAY be included as an additional observation code - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have an system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'cm', or '[in_i]'**" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/bodyheight", - "version" : "4.6.0", - "name" : "observation-bodyheight", - "title" : "Observation Body Height Profile", - "status" : "draft", - "experimental" : false, - "date" : "2018-08-11", - "publisher" : "Health Level Seven International (Orders and Observations Workgroup)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/orders/index.cfm Orders and Observations" - }] - }], - "description" : "FHIR Body Height Profile", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "workflow", - "uri" : "http://hl7.org/fhir/workflow", - "name" : "Workflow Pattern" - }, - { - "identity" : "sct-concept", - "uri" : "http://snomed.info/conceptdomain", - "name" : "SNOMED CT Concept Domain Binding" - }, - { - "identity" : "v2", - "uri" : "http://hl7.org/v2", - "name" : "HL7 v2 Mapping" - }, - { - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }, - { - "identity" : "sct-attr", - "uri" : "http://snomed.org/attributebinding", - "name" : "SNOMED CT Attribute Binding" - }], - "kind" : "resource", - "abstract" : false, - "type" : "Observation", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/vitalsigns", - "derivation" : "constraint", - "snapshot" : { - "element" : [{ - "id" : "Observation", - "path" : "Observation", - "short" : "FHIR Body Height Profile", - "definition" : "This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure.", - "comment" : "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.", - "alias" : ["Vital Signs", - "Measurement", - "Results", - "Tests"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation", - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "obs-6", - "severity" : "error", - "human" : "dataAbsentReason SHALL only be present if Observation.value[x] is not present", - "expression" : "dataAbsentReason.empty() or value.empty()", - "xpath" : "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }, - { - "key" : "obs-7", - "severity" : "error", - "human" : "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", - "expression" : "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", - "xpath" : "not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }, - { - "key" : "vs-2", - "severity" : "error", - "human" : "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", - "expression" : "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", - "xpath" : "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "workflow", - "map" : "Event" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity|" - }, - { - "identity" : "v2", - "map" : "OBX" - }, - { - "identity" : "rim", - "map" : "Observation[classCode=OBS, moodCode=EVN]" - }, - { - "identity" : "w5", - "map" : "clinical.diagnostics" - }] - }, - { - "id" : "Observation.id", - "path" : "Observation.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Observation.meta", - "path" : "Observation.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Observation.implicitRules", - "path" : "Observation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "Observation.language", - "path" : "Observation.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "Observation.text", - "path" : "Observation.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "Observation.contained", - "path" : "Observation.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.extension", - "path" : "Observation.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.modifierExtension", - "path" : "Observation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.identifier", - "path" : "Observation.identifier", - "short" : "Business Identifier for observation", - "definition" : "A unique identifier assigned to this observation.", - "requirements" : "Allows observations to be distinguished and referenced.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "v2", - "map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4." - }, - { - "identity" : "rim", - "map" : "id" - }] - }, - { - "id" : "Observation.instantiates[x]", - "path" : "Observation.instantiates[x]", - "short" : "Instantiates FHIR ObservationDefinition", - "definition" : "The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.", - "comment" : "ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.instantiates[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"] - }, - { - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.instantiatesCanonical" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "Observation.basedOn", - "path" : "Observation.basedOn", - "short" : "Fulfills plan, proposal or order", - "definition" : "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.", - "requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", - "alias" : ["Fulfills"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.basedOn", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan", - "http://hl7.org/fhir/StructureDefinition/DeviceRequest", - "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", - "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "http://hl7.org/fhir/StructureDefinition/NutritionOrder", - "http://hl7.org/fhir/StructureDefinition/ServiceRequest"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.basedOn" - }, - { - "identity" : "v2", - "map" : "ORC" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" - }] - }, - { - "id" : "Observation.partOf", - "path" : "Observation.partOf", - "short" : "Part of referenced event", - "definition" : "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", - "comment" : "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", - "alias" : ["Container"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.partOf", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration", - "http://hl7.org/fhir/StructureDefinition/MedicationDispense", - "http://hl7.org/fhir/StructureDefinition/MedicationUsage", - "http://hl7.org/fhir/StructureDefinition/Procedure", - "http://hl7.org/fhir/StructureDefinition/Immunization", - "http://hl7.org/fhir/StructureDefinition/ImagingStudy"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.partOf" - }, - { - "identity" : "v2", - "map" : "Varies by domain" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=FLFS].target" - }] - }, - { - "id" : "Observation.status", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", - "valueString" : "default: final" - }], - "path" : "Observation.status", - "short" : "registered | preliminary | final | amended +", - "definition" : "The status of the result value.", - "comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", - "requirements" : "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.status", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "Status" - }], - "strength" : "required", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-status" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.status" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "sct-concept", - "map" : "< 445584004 |Report by finality status|" - }, - { - "identity" : "v2", - "map" : "OBX-11" - }, - { - "identity" : "rim", - "map" : "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\"" - }] - }, - { - "id" : "Observation.category", - "path" : "Observation.category", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "coding.code" - }, - { - "type" : "value", - "path" : "coding.system" - }], - "ordered" : false, - "rules" : "open" - }, - "short" : "Classification of type of observation", - "definition" : "A code that classifies the general type of observation being made.", - "comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.", - "requirements" : "Used for filtering what observations are retrieved and displayed.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "Observation.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationCategory" - }], - "strength" : "preferred", - "description" : "Codes for high level observation categories.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" - }] - }, - { - "id" : "Observation.category:VSCat", - "path" : "Observation.category", - "sliceName" : "VSCat", - "short" : "Classification of type of observation", - "definition" : "A code that classifies the general type of observation being made.", - "comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.", - "requirements" : "Used for filtering what observations are retrieved and displayed.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationCategory" - }], - "strength" : "preferred", - "description" : "Codes for high level observation categories.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" - }] - }, - { - "id" : "Observation.category:VSCat.id", - "path" : "Observation.category.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.extension", - "path" : "Observation.category.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding", - "path" : "Observation.category.coding", - "short" : "Code defined by a terminology system", - "definition" : "A reference to a code defined by a terminology system.", - "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", - "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "CodeableConcept.coding", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1-8, C*E.10-22" - }, - { - "identity" : "rim", - "map" : "union(., ./translation)" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" - }] - }, - { - "id" : "Observation.category:VSCat.coding.id", - "path" : "Observation.category.coding.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding.extension", - "path" : "Observation.category.coding.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding.system", - "path" : "Observation.category.coding.system", - "short" : "Identity of the terminology system", - "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", - "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", - "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.system", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://terminology.hl7.org/CodeSystem/observation-category", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.3" - }, - { - "identity" : "rim", - "map" : "./codeSystem" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" - }] - }, - { - "id" : "Observation.category:VSCat.coding.version", - "path" : "Observation.category.coding.version", - "short" : "Version of the system - if relevant", - "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", - "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.version", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.7" - }, - { - "identity" : "rim", - "map" : "./codeSystemVersion" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" - }] - }, - { - "id" : "Observation.category:VSCat.coding.code", - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/no-binding", - "valueBoolean" : true - }], - "path" : "Observation.category.coding.code", - "short" : "Symbol in syntax defined by the system", - "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", - "requirements" : "Need to refer to a particular code in the system.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "fixedCode" : "vital-signs", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1" - }, - { - "identity" : "rim", - "map" : "./code" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" - }] - }, - { - "id" : "Observation.category:VSCat.coding.display", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.category.coding.display", - "short" : "Representation defined by the system", - "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", - "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.display", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.2 - but note this is not well followed" - }, - { - "identity" : "rim", - "map" : "CV.displayName" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" - }] - }, - { - "id" : "Observation.category:VSCat.coding.userSelected", - "path" : "Observation.category.coding.userSelected", - "short" : "If this coding was chosen directly by the user", - "definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", - "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", - "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.userSelected", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Sometimes implied by being first" - }, - { - "identity" : "rim", - "map" : "CD.codingRationale" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" - }] - }, - { - "id" : "Observation.category:VSCat.text", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.category.text", - "short" : "Plain text representation of the concept", - "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", - "comment" : "Very often the text is the same as a displayName of one of the codings.", - "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CodeableConcept.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.9. But note many systems use C*E.2 for this" - }, - { - "identity" : "rim", - "map" : "./originalText[mediaType/code=\"text/plain\"]/data" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" - }] - }, - { - "id" : "Observation.code", - "path" : "Observation.code", - "short" : "Body Height", - "definition" : "Body Height.", - "comment" : "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", - "requirements" : "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", - "alias" : ["Name", - "Test"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.code" - }, - { - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "code" - }, - { - "identity" : "sct-attr", - "map" : "116680003 |Is a|" - }] - }, - { - "id" : "Observation.code.id", - "path" : "Observation.code.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.extension", - "path" : "Observation.code.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.coding", - "path" : "Observation.code.coding", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "code" - }, - { - "type" : "value", - "path" : "system" - }], - "ordered" : false, - "rules" : "open" - }, - "short" : "Code defined by a terminology system", - "definition" : "A reference to a code defined by a terminology system.", - "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", - "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CodeableConcept.coding", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1-8, C*E.10-22" - }, - { - "identity" : "rim", - "map" : "union(., ./translation)" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode", - "path" : "Observation.code.coding", - "sliceName" : "BodyHeightCode", - "short" : "Code defined by a terminology system", - "definition" : "A reference to a code defined by a terminology system.", - "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", - "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "CodeableConcept.coding", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1-8, C*E.10-22" - }, - { - "identity" : "rim", - "map" : "union(., ./translation)" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode.id", - "path" : "Observation.code.coding.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode.extension", - "path" : "Observation.code.coding.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode.system", - "path" : "Observation.code.coding.system", - "short" : "Identity of the terminology system", - "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", - "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", - "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.system", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://loinc.org", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.3" - }, - { - "identity" : "rim", - "map" : "./codeSystem" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode.version", - "path" : "Observation.code.coding.version", - "short" : "Version of the system - if relevant", - "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", - "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.version", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.7" - }, - { - "identity" : "rim", - "map" : "./codeSystemVersion" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode.code", - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/no-binding", - "valueBoolean" : true - }], - "path" : "Observation.code.coding.code", - "short" : "Symbol in syntax defined by the system", - "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", - "requirements" : "Need to refer to a particular code in the system.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "fixedCode" : "8302-2", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1" - }, - { - "identity" : "rim", - "map" : "./code" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode.display", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.code.coding.display", - "short" : "Representation defined by the system", - "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", - "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.display", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.2 - but note this is not well followed" - }, - { - "identity" : "rim", - "map" : "CV.displayName" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" - }] - }, - { - "id" : "Observation.code.coding:BodyHeightCode.userSelected", - "path" : "Observation.code.coding.userSelected", - "short" : "If this coding was chosen directly by the user", - "definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", - "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", - "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.userSelected", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Sometimes implied by being first" - }, - { - "identity" : "rim", - "map" : "CD.codingRationale" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" - }] - }, - { - "id" : "Observation.code.text", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.code.text", - "short" : "Plain text representation of the concept", - "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", - "comment" : "Very often the text is the same as a displayName of one of the codings.", - "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CodeableConcept.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.9. But note many systems use C*E.2 for this" - }, - { - "identity" : "rim", - "map" : "./originalText[mediaType/code=\"text/plain\"]/data" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" - }] - }, - { - "id" : "Observation.subject", - "path" : "Observation.subject", - "short" : "Who and/or what the observation is about", - "definition" : "The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.", - "comment" : "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).", - "requirements" : "Observations have no value if you don't know who or what they're about.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.subject", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.subject" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=RTGT]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "Observation.focus", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "path" : "Observation.focus", - "short" : "What the observation is about, when it is not about the subject of record", - "definition" : "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.", - "comment" : "Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [focusCode](extension-observation-focuscode.html).", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.focus", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=SBJ]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "Observation.encounter", - "path" : "Observation.encounter", - "short" : "Healthcare event during which this observation is made", - "definition" : "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", - "comment" : "This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).", - "requirements" : "For some observations it may be important to know the link between an observation and a particular encounter.", - "alias" : ["Context"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.encounter", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.context" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "PV1" - }, - { - "identity" : "rim", - "map" : "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" - }] - }, - { - "id" : "Observation.effective[x]", - "path" : "Observation.effective[x]", - "short" : "Often just a dateTime for Vital Signs", - "definition" : "Often just a dateTime for Vital Signs.", - "comment" : "At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.", - "requirements" : "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", - "alias" : ["Occurrence"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.effective[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }, - { - "code" : "Period" - }], - "condition" : ["vs-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "vs-1", - "severity" : "error", - "human" : "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", - "expression" : "($this as dateTime).toString().length() >= 8", - "xpath" : "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.occurrence[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.done[x]" - }, - { - "identity" : "v2", - "map" : "OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)" - }, - { - "identity" : "rim", - "map" : "effectiveTime" - }] - }, - { - "id" : "Observation.issued", - "path" : "Observation.issued", - "short" : "Date/Time this version was made available", - "definition" : "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", - "comment" : "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.issued", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "instant" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "v2", - "map" : "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=AUT].time" - }] - }, - { - "id" : "Observation.performer", - "path" : "Observation.performer", - "short" : "Who is responsible for the observation", - "definition" : "Who was responsible for asserting the observed value as \"true\".", - "requirements" : "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.performer", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/CareTeam", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.performer.actor" - }, - { - "identity" : "w5", - "map" : "FiveWs.actor" - }, - { - "identity" : "v2", - "map" : "OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=PRF]" - }] - }, - { - "id" : "Observation.value[x]", - "path" : "Observation.value[x]", - "slicing" : { - "discriminator" : [{ - "type" : "type", - "path" : "$this" - }], - "ordered" : false, - "rules" : "closed" - }, - "short" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "definition" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "comment" : "- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }], - "condition" : ["obs-7", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity", - "path" : "Observation.value[x]", - "sliceName" : "valueQuantity", - "short" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "definition" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "comment" : "- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }], - "condition" : ["obs-7", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.id", - "path" : "Observation.value[x].id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.extension", - "path" : "Observation.value[x].extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.value", - "path" : "Observation.value[x].value", - "short" : "Numerical value (with implicit precision)", - "definition" : "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", - "comment" : "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", - "requirements" : "Precision is handled implicitly in almost all cases of measurement.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.value", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "decimal" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "SN.2 / CQ - N/A" - }, - { - "identity" : "rim", - "map" : "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.comparator", - "path" : "Observation.value[x].comparator", - "short" : "< | <= | >= | > | ad - how to understand the value", - "definition" : "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", - "requirements" : "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Quantity.comparator", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "meaningWhenMissing" : "If there is no comparator, then there is no modification of the value", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : true, - "isModifierReason" : "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "How the Quantity should be understood and represented." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "QuantityComparator" - }], - "strength" : "required", - "valueSet" : "http://hl7.org/fhir/ValueSet/quantity-comparator|4.6.0" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "SN.1 / CQ.1" - }, - { - "identity" : "rim", - "map" : "IVL properties" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.unit", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.value[x].unit", - "short" : "Unit representation", - "definition" : "A human-readable form of the unit.", - "requirements" : "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.unit", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "(see OBX.6 etc.) / CQ.2" - }, - { - "identity" : "rim", - "map" : "PQ.unit" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.system", - "path" : "Observation.value[x].system", - "short" : "System that defines coded unit form", - "definition" : "The identification of the system that provides the coded form of the unit.", - "requirements" : "Need to know the system that defines the coded form of the unit.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.system", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://unitsofmeasure.org", - "condition" : ["qty-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "(see OBX.6 etc.) / CQ.2" - }, - { - "identity" : "rim", - "map" : "CO.codeSystem, PQ.translation.codeSystem" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.code", - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/no-binding", - "valueBoolean" : true - }], - "path" : "Observation.value[x].code", - "short" : "Coded responses from the common UCUM units for vital signs value set.", - "definition" : "Coded responses from the common UCUM units for vital signs value set.", - "comment" : "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", - "requirements" : "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for body length measures such as Body Height and Head Circumference." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodyLengthUnits" - }], - "strength" : "required", - "description" : "cm | [in_i]", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-bodylength" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "(see OBX.6 etc.) / CQ.2" - }, - { - "identity" : "rim", - "map" : "PQ.code, MO.currency, PQ.translation.code" - }] - }, - { - "id" : "Observation.dataAbsentReason", - "path" : "Observation.dataAbsentReason", - "short" : "Why the result is missing", - "definition" : "Provides a reason why the expected value in the element Observation.value[x] is missing.", - "comment" : "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.", - "requirements" : "For many results it is necessary to handle exceptional values in measurements.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.dataAbsentReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["obs-6", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationValueAbsentReason" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Codes specifying why the result (`Observation.value[x]`) is missing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "N/A" - }, - { - "identity" : "rim", - "map" : "value.nullFlavor" - }] - }, - { - "id" : "Observation.interpretation", - "path" : "Observation.interpretation", - "short" : "High, low, normal, etc.", - "definition" : "A categorical assessment of an observation value. For example, high, low, normal.", - "comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", - "requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", - "alias" : ["Abnormal Flag"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.interpretation", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationInterpretation" - }], - "strength" : "extensible", - "description" : "Codes identifying interpretations of observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values|" - }, - { - "identity" : "v2", - "map" : "OBX-8" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }, - { - "identity" : "sct-attr", - "map" : "363713009 |Has interpretation|" - }] - }, - { - "id" : "Observation.note", - "path" : "Observation.note", - "short" : "Comments about the observation", - "definition" : "Comments about the observation or the results.", - "comment" : "May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.", - "requirements" : "Need to be able to provide free text additional information.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.note", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)" - }, - { - "identity" : "rim", - "map" : "subjectOf.observationEvent[code=\"annotation\"].value" - }] - }, - { - "id" : "Observation.bodySite", - "path" : "Observation.bodySite", - "short" : "Observed body part", - "definition" : "Indicates the site on the subject's body where the observation was made (i.e. the target site).", - "comment" : "Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.bodySite", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Codes describing anatomical locations. May include laterality." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodySite" - }], - "strength" : "example", - "description" : "SNOMED CT Body site concepts", - "valueSet" : "http://hl7.org/fhir/ValueSet/body-site" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 123037004 |Body structure|" - }, - { - "identity" : "v2", - "map" : "OBX-20" - }, - { - "identity" : "rim", - "map" : "targetSiteCode" - }, - { - "identity" : "sct-attr", - "map" : "718497002 |Inherent location|" - }] - }, - { - "id" : "Observation.method", - "path" : "Observation.method", - "short" : "How it was done", - "definition" : "Indicates the mechanism used to perform the observation.", - "comment" : "Only used if not implicit in code for Observation.code.", - "requirements" : "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.method", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationMethod" - }], - "strength" : "example", - "description" : "Methods for simple observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-17" - }, - { - "identity" : "rim", - "map" : "methodCode" - }] - }, - { - "id" : "Observation.specimen", - "path" : "Observation.specimen", - "short" : "Specimen used for this observation", - "definition" : "The specimen that was used when this observation was made.", - "comment" : "Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.specimen", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 123038009 |Specimen|" - }, - { - "identity" : "v2", - "map" : "SPM segment" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=SPC].specimen" - }, - { - "identity" : "sct-attr", - "map" : "704319004 |Inherent in|" - }] - }, - { - "id" : "Observation.device", - "path" : "Observation.device", - "short" : "(Measurement) Device", - "definition" : "The device used to generate the observation data.", - "comment" : "Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.device", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/DeviceMetric"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 49062001 |Device|" - }, - { - "identity" : "v2", - "map" : "OBX-17 / PRT -10" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=DEV]" - }, - { - "identity" : "sct-attr", - "map" : "424226004 |Using device|" - }] - }, - { - "id" : "Observation.referenceRange", - "path" : "Observation.referenceRange", - "short" : "Provides guide for interpretation", - "definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.", - "comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", - "requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.referenceRange", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "obs-3", - "severity" : "error", - "human" : "Must have at least a low or a high or text", - "expression" : "low.exists() or high.exists() or text.exists()", - "xpath" : "(exists(f:low) or exists(f:high)or exists(f:text))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX.7" - }, - { - "identity" : "rim", - "map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" - }] - }, - { - "id" : "Observation.referenceRange.id", - "path" : "Observation.referenceRange.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.referenceRange.extension", - "path" : "Observation.referenceRange.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.referenceRange.modifierExtension", - "path" : "Observation.referenceRange.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.referenceRange.low", - "path" : "Observation.referenceRange.low", - "short" : "Low Range, if relevant", - "definition" : "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).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.low", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "condition" : ["obs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:IVL_PQ.low" - }] - }, - { - "id" : "Observation.referenceRange.high", - "path" : "Observation.referenceRange.high", - "short" : "High Range, if relevant", - "definition" : "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).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.high", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "condition" : ["obs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:IVL_PQ.high" - }] - }, - { - "id" : "Observation.referenceRange.type", - "path" : "Observation.referenceRange.type", - "short" : "Reference range qualifier", - "definition" : "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", - "comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", - "requirements" : "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.type", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationRangeMeaning" - }], - "strength" : "preferred", - "description" : "Code for the meaning of a reference range.", - "valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|" - }, - { - "identity" : "v2", - "map" : "OBX-10" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }] - }, - { - "id" : "Observation.referenceRange.appliesTo", - "path" : "Observation.referenceRange.appliesTo", - "short" : "Reference range population", - "definition" : "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.", - "comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", - "requirements" : "Need to be able to identify the target population for proper interpretation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.referenceRange.appliesTo", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationRangeType" - }], - "strength" : "example", - "description" : "Codes identifying the population the reference range applies to.", - "valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|" - }, - { - "identity" : "v2", - "map" : "OBX-10" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }] - }, - { - "id" : "Observation.referenceRange.age", - "path" : "Observation.referenceRange.age", - "short" : "Applicable age range, if relevant", - "definition" : "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.", - "requirements" : "Some analytes vary greatly over age.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.age", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Range" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" - }] - }, - { - "id" : "Observation.referenceRange.text", - "path" : "Observation.referenceRange.text", - "short" : "Text based reference range in an observation", - "definition" : "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\".", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:ST" - }] - }, - { - "id" : "Observation.hasMember", - "path" : "Observation.hasMember", - "short" : "Used when reporting vital signs panel components", - "definition" : "Used when reporting vital signs panel components.", - "comment" : "When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.hasMember", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Relationships established by OBX-4 usage" - }, - { - "identity" : "rim", - "map" : "outBoundRelationship" - }] - }, - { - "id" : "Observation.derivedFrom", - "path" : "Observation.derivedFrom", - "short" : "Related measurements the observation is made from", - "definition" : "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.", - "comment" : "All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.derivedFrom", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference", - "http://hl7.org/fhir/StructureDefinition/ImagingStudy", - "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Relationships established by OBX-4 usage" - }, - { - "identity" : "rim", - "map" : ".targetObservation" - }] - }, - { - "id" : "Observation.component", - "path" : "Observation.component", - "short" : "Used when reporting systolic and diastolic blood pressure.", - "definition" : "Used when reporting systolic and diastolic blood pressure.", - "comment" : "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", - "requirements" : "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "vs-3", - "severity" : "error", - "human" : "If there is no a value a data absent reason must be present", - "expression" : "value.exists() or dataAbsentReason.exists()", - "xpath" : "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "containment by OBX-4?" - }, - { - "identity" : "rim", - "map" : "outBoundRelationship[typeCode=COMP]" - }] - }, - { - "id" : "Observation.component.id", - "path" : "Observation.component.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.component.extension", - "path" : "Observation.component.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.component.modifierExtension", - "path" : "Observation.component.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.component.code", - "path" : "Observation.component.code", - "short" : "Type of component observation (code / type)", - "definition" : "Describes what was observed. Sometimes this is called the observation \"code\".", - "comment" : "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", - "requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.component.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "code" - }] - }, - { - "id" : "Observation.component.value[x]", - "path" : "Observation.component.value[x]", - "short" : "Vital Sign Value recorded with UCUM", - "definition" : "Vital Sign Value recorded with UCUM.", - "comment" : "Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.component.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }, - { - "code" : "CodeableConcept" - }, - { - "code" : "string" - }, - { - "code" : "boolean" - }, - { - "code" : "integer" - }, - { - "code" : "Range" - }, - { - "code" : "Ratio" - }, - { - "code" : "SampledData" - }, - { - "code" : "time" - }, - { - "code" : "dateTime" - }, - { - "code" : "Period" - }, - { - "code" : "Attachment" - }], - "condition" : ["vs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for recording Vital Signs." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSignsUnits" - }], - "strength" : "required", - "description" : "Commonly encountered UCUM units for recording Vital Signs.", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-vitals-common" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "363714003 |Interprets| < 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.component.dataAbsentReason", - "path" : "Observation.component.dataAbsentReason", - "short" : "Why the component result is missing", - "definition" : "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", - "comment" : "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.", - "requirements" : "For many results it is necessary to handle exceptional values in measurements.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.component.dataAbsentReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["obs-6", - "vs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationValueAbsentReason" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Codes specifying why the result (`Observation.value[x]`) is missing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "N/A" - }, - { - "identity" : "rim", - "map" : "value.nullFlavor" - }] - }, - { - "id" : "Observation.component.interpretation", - "path" : "Observation.component.interpretation", - "short" : "High, low, normal, etc.", - "definition" : "A categorical assessment of an observation value. For example, high, low, normal.", - "comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", - "requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", - "alias" : ["Abnormal Flag"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component.interpretation", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationInterpretation" - }], - "strength" : "extensible", - "description" : "Codes identifying interpretations of observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values|" - }, - { - "identity" : "v2", - "map" : "OBX-8" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }, - { - "identity" : "sct-attr", - "map" : "363713009 |Has interpretation|" - }] - }, - { - "id" : "Observation.component.referenceRange", - "path" : "Observation.component.referenceRange", - "short" : "Provides guide for interpretation of component result", - "definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range.", - "comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", - "requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component.referenceRange", - "min" : 0, - "max" : "*" - }, - "contentReference" : "http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX.7" - }, - { - "identity" : "rim", - "map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "Observation", - "path" : "Observation", - "short" : "FHIR Body Height Profile", - "definition" : "This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure.", - "min" : 0, - "max" : "*" - }, - { - "id" : "Observation.code", - "path" : "Observation.code", - "short" : "Body Height", - "definition" : "Body Height.", - "comment" : "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", - "alias" : ["Test", - "Name"] - }, - { - "id" : "Observation.code.coding", - "path" : "Observation.code.coding", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "code" - }, - { - "type" : "value", - "path" : "system" - }], - "ordered" : false, - "rules" : "open" - } - }, - { - "id" : "Observation.code.coding:BodyHeightCode", - "path" : "Observation.code.coding", - "sliceName" : "BodyHeightCode", - "min" : 1, - "max" : "1" - }, - { - "id" : "Observation.code.coding:BodyHeightCode.system", - "path" : "Observation.code.coding.system", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://loinc.org" - }, - { - "id" : "Observation.code.coding:BodyHeightCode.code", - "path" : "Observation.code.coding.code", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "fixedCode" : "8302-2" - }, - { - "id" : "Observation.valueQuantity", - "path" : "Observation.valueQuantity" - }, - { - "id" : "Observation.valueQuantity.value", - "path" : "Observation.valueQuantity.value", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "decimal" - }], - "mustSupport" : true - }, - { - "id" : "Observation.valueQuantity.unit", - "path" : "Observation.valueQuantity.unit", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : true - }, - { - "id" : "Observation.valueQuantity.system", - "path" : "Observation.valueQuantity.system", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://unitsofmeasure.org", - "mustSupport" : true - }, - { - "id" : "Observation.valueQuantity.code", - "path" : "Observation.valueQuantity.code", - "short" : "Coded responses from the common UCUM units for vital signs value set.", - "definition" : "Coded responses from the common UCUM units for vital signs value set.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for body length measures such as Body Height and Head Circumference." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodyLengthUnits" - }], - "strength" : "required", - "description" : "cm | [in_i]", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-bodylength" - } - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"bodyheight","text":{"status":"generated","div":"
to do
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-summary","valueMarkdown":"#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'8302-2'**\r - 8306-3 -Body height - lying (i.e., body length - typically used for infants) MAY be included as an additional observation code - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have a system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'cm', or '[in_i]'**"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"oo"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/tools/StructureDefinition/profile-summary","valueString":"#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'8302-2'**\r - 8306-3 -Body height - lying (i.e., body length - typically used for infants) MAY be included as an additional observation code - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have a system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'cm', or '[in_i]'**"}],"url":"http://hl7.org/fhir/StructureDefinition/bodyheight","identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:2.16.840.1.113883.4.642.5.1463"}],"version":"5.0.0","name":"Observationbodyheight","title":"Observation Body Height Profile","status":"draft","experimental":false,"date":"2018-08-11","publisher":"Health Level Seven International (Orders and Observations Workgroup)","contact":[{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/orders/index.cfm Orders and Observations"}]}],"description":"FHIR Body Height Profile","fhirVersion":"5.0.0","mapping":[{"identity":"workflow","uri":"http://hl7.org/fhir/workflow","name":"Workflow Pattern"},{"identity":"sct-concept","uri":"http://snomed.info/conceptdomain","name":"SNOMED CT Concept Domain Binding"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"sct-attr","uri":"http://snomed.org/attributebinding","name":"SNOMED CT Attribute Binding"}],"kind":"resource","abstract":false,"type":"Observation","baseDefinition":"http://hl7.org/fhir/StructureDefinition/vitalsigns","derivation":"constraint","snapshot":{"element":[{"id":"Observation","path":"Observation","short":"FHIR Body Height Profile","definition":"This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure.","comment":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.","alias":["Vital Signs","Measurement","Results","Tests"],"min":0,"max":"*","base":{"path":"Observation","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"obs-6","severity":"error","human":"dataAbsentReason SHALL only be present if Observation.value[x] is not present","expression":"dataAbsentReason.empty() or value.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-7","severity":"error","human":"If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).","expression":"value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-8","severity":"error","human":"bodyStructure SHALL only be present if Observation.bodySite is not present","expression":"bodySite.exists() implies bodyStructure.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"vs-2","severity":"error","human":"If there is no component or hasMember element then either a value[x] or a data absent reason must be present.","expression":"(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Observation[classCode=OBS, moodCode=EVN]"},{"identity":"workflow","map":"Event"},{"identity":"w5","map":"clinical.diagnostics"},{"identity":"sct-concept","map":"< 363787002 |Observable entity|"},{"identity":"v2","map":"OBX"}]},{"id":"Observation.id","path":"Observation.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.meta","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.implicitRules","path":"Observation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Observation.language","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Observation.text","path":"Observation.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Observation.contained","path":"Observation.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.extension","path":"Observation.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.modifierExtension","path":"Observation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.identifier","path":"Observation.identifier","short":"Business Identifier for observation","definition":"A unique identifier assigned to this observation.","requirements":"Allows observations to be distinguished and referenced.","min":0,"max":"*","base":{"path":"Observation.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"OBX-21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 3) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."},{"identity":"rim","map":"id"}]},{"id":"Observation.instantiates[x]","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.instantiates[x]","short":"Instantiates FHIR ObservationDefinition","definition":"The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.","comment":"ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.","min":0,"max":"1","base":{"path":"Observation.instantiates[x]","min":0,"max":"1"},"type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"Observation.basedOn","path":"Observation.basedOn","short":"Fulfills plan, proposal or order","definition":"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.","requirements":"Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","alias":["Fulfills"],"min":0,"max":"*","base":{"path":"Observation.basedOn","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.basedOn"},{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.triggeredBy","short":"Triggering observation(s)","definition":"Identifies the observation(s) that triggered the performance of this observation.","min":0,"max":"*","base":{"path":"Observation.triggeredBy","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy.id","path":"Observation.triggeredBy.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.extension","path":"Observation.triggeredBy.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.modifierExtension","path":"Observation.triggeredBy.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.triggeredBy.observation","path":"Observation.triggeredBy.observation","short":"Triggering observation","definition":"Reference to the triggering observation.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.observation","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.triggeredBy.type","path":"Observation.triggeredBy.type","short":"reflex | repeat | re-run","definition":"The type of trigger.\nReflex | Repeat | Re-run.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TriggeredByType"}],"strength":"required","description":"The type of TriggeredBy Observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-triggeredbytype|5.0.0"},"mapping":[{"identity":"rim","map":"code"}]},{"id":"Observation.triggeredBy.reason","path":"Observation.triggeredBy.reason","short":"Reason that the observation was triggered","definition":"Provides the reason why this observation was performed as a result of the observation(s) referenced.","min":0,"max":"1","base":{"path":"Observation.triggeredBy.reason","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"annotation"}]},{"id":"Observation.partOf","path":"Observation.partOf","short":"Part of referenced event","definition":"A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.","comment":"To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.","alias":["Container"],"min":0,"max":"*","base":{"path":"Observation.partOf","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationAdministration","http://hl7.org/fhir/StructureDefinition/MedicationDispense","http://hl7.org/fhir/StructureDefinition/MedicationStatement","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Immunization","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/GenomicStudy"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.partOf"},{"identity":"v2","map":"Varies by domain"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target"}]},{"id":"Observation.status","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint","valueString":"default: final"}],"path":"Observation.status","short":"registered | preliminary | final | amended +","definition":"The status of the result value.","comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","requirements":"Need to track the status of individual results. Some results are finalized before the whole report is finalized.","min":1,"max":"1","base":{"path":"Observation.status","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Status"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/observation-status"},"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 445584004 |Report by finality status|"},{"identity":"v2","map":"OBX-11"},{"identity":"rim","map":"status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}]},{"id":"Observation.category","path":"Observation.category","slicing":{"discriminator":[{"type":"value","path":"coding.code"},{"type":"value","path":"coding.system"}],"ordered":false,"rules":"open"},"short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":1,"max":"*","base":{"path":"Observation.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.category:VSCat","path":"Observation.category","sliceName":"VSCat","short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":1,"max":"1","base":{"path":"Observation.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.category:VSCat.id","path":"Observation.category.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.extension","path":"Observation.category.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding","path":"Observation.category.coding","short":"Code defined by a terminology system","definition":"A reference to a code defined by a terminology system.","comment":"Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.","requirements":"Allows for alternative encodings within a code system, and translations to other code systems.","min":1,"max":"*","base":{"path":"CodeableConcept.coding","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1-8, C*E.10-22"},{"identity":"rim","map":"union(., ./translation)"},{"identity":"orim","map":"fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]},{"id":"Observation.category:VSCat.coding.id","path":"Observation.category.coding.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding.extension","path":"Observation.category.coding.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding.system","path":"Observation.category.coding.system","short":"Identity of the terminology system","definition":"The identification of the code system that defines the meaning of the symbol in the code.","comment":"The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.","requirements":"Need to be unambiguous about the source of the definition of the symbol.","min":1,"max":"1","base":{"path":"Coding.system","min":0,"max":"1"},"type":[{"code":"uri"}],"fixedUri":"http://terminology.hl7.org/CodeSystem/observation-category","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.3"},{"identity":"rim","map":"./codeSystem"},{"identity":"orim","map":"fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]},{"id":"Observation.category:VSCat.coding.version","path":"Observation.category.coding.version","short":"Version of the system - if relevant","definition":"The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.","comment":"Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.","min":0,"max":"1","base":{"path":"Coding.version","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.7"},{"identity":"rim","map":"./codeSystemVersion"},{"identity":"orim","map":"fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]},{"id":"Observation.category:VSCat.coding.code","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/no-binding","valueBoolean":true}],"path":"Observation.category.coding.code","short":"Symbol in syntax defined by the system","definition":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).","requirements":"Need to refer to a particular code in the system.","min":1,"max":"1","base":{"path":"Coding.code","min":0,"max":"1"},"type":[{"code":"code"}],"fixedCode":"vital-signs","condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1"},{"identity":"rim","map":"./code"},{"identity":"orim","map":"fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]},{"id":"Observation.category:VSCat.coding.display","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.category.coding.display","short":"Representation defined by the system","definition":"A representation of the meaning of the code in the system, following the rules of the system.","requirements":"Need to be able to carry a human-readable meaning of the code for readers that do not know the system.","min":0,"max":"1","base":{"path":"Coding.display","min":0,"max":"1"},"type":[{"code":"string"}],"condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.2 - but note this is not well followed"},{"identity":"rim","map":"CV.displayName"},{"identity":"orim","map":"fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]},{"id":"Observation.category:VSCat.coding.userSelected","path":"Observation.category.coding.userSelected","short":"If this coding was chosen directly by the user","definition":"Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).","comment":"Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.","requirements":"This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.","min":0,"max":"1","base":{"path":"Coding.userSelected","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Sometimes implied by being first"},{"identity":"rim","map":"CD.codingRationale"},{"identity":"orim","map":"fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"}]},{"id":"Observation.category:VSCat.text","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.category.text","short":"Plain text representation of the concept","definition":"A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.","comment":"Very often the text is the same as a displayName of one of the codings.","requirements":"The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.","min":0,"max":"1","base":{"path":"CodeableConcept.text","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.9. But note many systems use C*E.2 for this"},{"identity":"rim","map":"./originalText[mediaType/code=\"text/plain\"]/data"},{"identity":"orim","map":"fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"}]},{"id":"Observation.code","path":"Observation.code","short":"Body Height","definition":"Body Height.","comment":"additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.","requirements":"5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).","alias":["Name","Test"],"min":1,"max":"1","base":{"path":"Observation.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"},{"identity":"sct-attr","map":"116680003 |Is a|"}]},{"id":"Observation.code.id","path":"Observation.code.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.extension","path":"Observation.code.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.coding","path":"Observation.code.coding","slicing":{"discriminator":[{"type":"value","path":"code"},{"type":"value","path":"system"}],"ordered":false,"rules":"open"},"short":"Code defined by a terminology system","definition":"A reference to a code defined by a terminology system.","comment":"Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.","requirements":"Allows for alternative encodings within a code system, and translations to other code systems.","min":0,"max":"*","base":{"path":"CodeableConcept.coding","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1-8, C*E.10-22"},{"identity":"rim","map":"union(., ./translation)"},{"identity":"orim","map":"fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]},{"id":"Observation.code.coding:BodyHeightCode","path":"Observation.code.coding","sliceName":"BodyHeightCode","short":"Code defined by a terminology system","definition":"A reference to a code defined by a terminology system.","comment":"Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.","requirements":"Allows for alternative encodings within a code system, and translations to other code systems.","min":1,"max":"1","base":{"path":"CodeableConcept.coding","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1-8, C*E.10-22"},{"identity":"rim","map":"union(., ./translation)"},{"identity":"orim","map":"fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]},{"id":"Observation.code.coding:BodyHeightCode.id","path":"Observation.code.coding.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.coding:BodyHeightCode.extension","path":"Observation.code.coding.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.coding:BodyHeightCode.system","path":"Observation.code.coding.system","short":"Identity of the terminology system","definition":"The identification of the code system that defines the meaning of the symbol in the code.","comment":"The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.","requirements":"Need to be unambiguous about the source of the definition of the symbol.","min":1,"max":"1","base":{"path":"Coding.system","min":0,"max":"1"},"type":[{"code":"uri"}],"fixedUri":"http://loinc.org","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.3"},{"identity":"rim","map":"./codeSystem"},{"identity":"orim","map":"fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]},{"id":"Observation.code.coding:BodyHeightCode.version","path":"Observation.code.coding.version","short":"Version of the system - if relevant","definition":"The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.","comment":"Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.","min":0,"max":"1","base":{"path":"Coding.version","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.7"},{"identity":"rim","map":"./codeSystemVersion"},{"identity":"orim","map":"fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]},{"id":"Observation.code.coding:BodyHeightCode.code","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/no-binding","valueBoolean":true}],"path":"Observation.code.coding.code","short":"Symbol in syntax defined by the system","definition":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).","requirements":"Need to refer to a particular code in the system.","min":1,"max":"1","base":{"path":"Coding.code","min":0,"max":"1"},"type":[{"code":"code"}],"fixedCode":"8302-2","condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1"},{"identity":"rim","map":"./code"},{"identity":"orim","map":"fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]},{"id":"Observation.code.coding:BodyHeightCode.display","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.code.coding.display","short":"Representation defined by the system","definition":"A representation of the meaning of the code in the system, following the rules of the system.","requirements":"Need to be able to carry a human-readable meaning of the code for readers that do not know the system.","min":0,"max":"1","base":{"path":"Coding.display","min":0,"max":"1"},"type":[{"code":"string"}],"condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.2 - but note this is not well followed"},{"identity":"rim","map":"CV.displayName"},{"identity":"orim","map":"fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]},{"id":"Observation.code.coding:BodyHeightCode.userSelected","path":"Observation.code.coding.userSelected","short":"If this coding was chosen directly by the user","definition":"Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).","comment":"Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.","requirements":"This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.","min":0,"max":"1","base":{"path":"Coding.userSelected","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Sometimes implied by being first"},{"identity":"rim","map":"CD.codingRationale"},{"identity":"orim","map":"fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"}]},{"id":"Observation.code.text","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.code.text","short":"Plain text representation of the concept","definition":"A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.","comment":"Very often the text is the same as a displayName of one of the codings.","requirements":"The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.","min":0,"max":"1","base":{"path":"CodeableConcept.text","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.9. But note many systems use C*E.2 for this"},{"identity":"rim","map":"./originalText[mediaType/code=\"text/plain\"]/data"},{"identity":"orim","map":"fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"}]},{"id":"Observation.subject","path":"Observation.subject","short":"Who and/or what the observation is about","definition":"The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.","comment":"One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).","requirements":"Observations have no value if you don't know who or what they're about.","min":1,"max":"1","base":{"path":"Observation.subject","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"participation[typeCode=RTGT]"}]},{"id":"Observation.focus","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.focus","short":"What the observation is about, when it is not about the subject of record","definition":"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.","comment":"Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).","min":0,"max":"*","base":{"path":"Observation.focus","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"participation[typeCode=SBJ]"}]},{"id":"Observation.encounter","path":"Observation.encounter","short":"Healthcare event during which this observation is made","definition":"The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.","comment":"This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).","requirements":"For some observations it may be important to know the link between an observation and a particular encounter.","alias":["Context"],"min":0,"max":"1","base":{"path":"Observation.encounter","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.encounter"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1"},{"identity":"rim","map":"inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]},{"id":"Observation.effective[x]","path":"Observation.effective[x]","short":"Often just a dateTime for Vital Signs","definition":"Often just a dateTime for Vital Signs.","comment":"At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","requirements":"Knowing when an observation was deemed true is important to its relevance as well as determining trends.","alias":["Occurrence"],"min":1,"max":"1","base":{"path":"Observation.effective[x]","min":0,"max":"1"},"type":[{"code":"dateTime"},{"code":"Period"}],"condition":["vs-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"vs-1","severity":"error","human":"if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day","expression":"($this as dateTime).toString().length() >= 8","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"},{"identity":"rim","map":"effectiveTime"}]},{"id":"Observation.issued","path":"Observation.issued","short":"Date/Time this version was made available","definition":"The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","comment":"For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.","min":0,"max":"1","base":{"path":"Observation.issued","min":0,"max":"1"},"type":[{"code":"instant"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"OBR-22 (or MSH-7), or perhaps OBX-19 (depends on who observation made)"},{"identity":"rim","map":"participation[typeCode=AUT].time"}]},{"id":"Observation.performer","path":"Observation.performer","short":"Who is responsible for the observation","definition":"Who was responsible for asserting the observed value as \"true\".","requirements":"May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","min":0,"max":"*","base":{"path":"Observation.performer","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"v2","map":"OBX-15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"},{"identity":"rim","map":"participation[typeCode=PRF]"}]},{"id":"Observation.value[x]","path":"Observation.value[x]","slicing":{"discriminator":[{"type":"type","path":"$this"}],"ordered":false,"rules":"open"},"short":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","definition":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["obs-7","obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.value[x]:valueQuantity","path":"Observation.value[x]","sliceName":"valueQuantity","short":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","definition":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"}],"condition":["obs-7","obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.value[x]:valueQuantity.id","path":"Observation.value[x].id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.value[x]:valueQuantity.extension","path":"Observation.value[x].extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.value[x]:valueQuantity.value","path":"Observation.value[x].value","short":"Numerical value (with implicit precision)","definition":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.","comment":"The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).","requirements":"Precision is handled implicitly in almost all cases of measurement.","min":1,"max":"1","base":{"path":"Quantity.value","min":0,"max":"1"},"type":[{"code":"decimal"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"SN.2 / CQ - N/A"},{"identity":"rim","map":"PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"}]},{"id":"Observation.value[x]:valueQuantity.comparator","path":"Observation.value[x].comparator","short":"< | <= | >= | > | ad - how to understand the value","definition":"How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.","requirements":"Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.","min":0,"max":"1","base":{"path":"Quantity.comparator","min":0,"max":"1"},"type":[{"code":"code"}],"meaningWhenMissing":"If there is no comparator, then there is no modification of the value","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":true,"isModifierReason":"This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"How the Quantity should be understood and represented."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"QuantityComparator"}],"strength":"required","description":"How the Quantity should be understood and represented.","valueSet":"http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"},"mapping":[{"identity":"v2","map":"SN.1 / CQ.1"},{"identity":"rim","map":"IVL properties"}]},{"id":"Observation.value[x]:valueQuantity.unit","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.value[x].unit","short":"Unit representation","definition":"A human-readable form of the unit.","requirements":"There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.","min":1,"max":"1","base":{"path":"Quantity.unit","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"(see OBX.6 etc.) / CQ.2"},{"identity":"rim","map":"PQ.unit"}]},{"id":"Observation.value[x]:valueQuantity.system","path":"Observation.value[x].system","short":"System that defines coded unit form","definition":"The identification of the system that provides the coded form of the unit.","requirements":"Need to know the system that defines the coded form of the unit.","min":1,"max":"1","base":{"path":"Quantity.system","min":0,"max":"1"},"type":[{"code":"uri"}],"fixedUri":"http://unitsofmeasure.org","condition":["qty-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"(see OBX.6 etc.) / CQ.2"},{"identity":"rim","map":"CO.codeSystem, PQ.translation.codeSystem"}]},{"id":"Observation.value[x]:valueQuantity.code","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/no-binding","valueBoolean":true}],"path":"Observation.value[x].code","short":"Coded responses from the common UCUM units for vital signs value set.","definition":"Coded responses from the common UCUM units for vital signs value set.","comment":"The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.","requirements":"Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.","min":1,"max":"1","base":{"path":"Quantity.code","min":0,"max":"1"},"type":[{"code":"code"}],"condition":["qty-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for body length measures such as Body Height and Head Circumference."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodyLengthUnits"}],"strength":"required","description":"cm | [in_i]","valueSet":"http://hl7.org/fhir/ValueSet/ucum-bodylength"},"mapping":[{"identity":"v2","map":"(see OBX.6 etc.) / CQ.2"},{"identity":"rim","map":"PQ.code, MO.currency, PQ.translation.code"}]},{"id":"Observation.dataAbsentReason","path":"Observation.dataAbsentReason","short":"Why the result is missing","definition":"Provides a reason why the expected value in the element Observation.value[x] is missing.","comment":"Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.interpretation","path":"Observation.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.note","path":"Observation.note","short":"Comments about the observation","definition":"Comments about the observation or the results.","comment":"May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.","requirements":"Need to be able to provide free text additional information.","min":0,"max":"*","base":{"path":"Observation.note","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE-3 (partner NTE to OBX, or sometimes another (child?) OBX)"},{"identity":"rim","map":"subjectOf.observationEvent[code=\"annotation\"].value"}]},{"id":"Observation.bodySite","path":"Observation.bodySite","short":"Observed body part","definition":"Indicates the site on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodySite","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","description":"SNOMED CT Body site concepts","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"mapping":[{"identity":"sct-concept","map":"< 123037004 |Body structure|"},{"identity":"v2","map":"OBX-20"},{"identity":"rim","map":"targetSiteCode"},{"identity":"sct-attr","map":"718497002 |Inherent location|"}]},{"id":"Observation.bodyStructure","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.bodyStructure","short":"Observed body structure","definition":"Indicates the body structure on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodyStructure","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/BodyStructure"]}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"targetSiteCode"}]},{"id":"Observation.method","path":"Observation.method","short":"How it was done","definition":"Indicates the mechanism used to perform the observation.","comment":"Only used if not implicit in code for Observation.code.","requirements":"In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","min":0,"max":"1","base":{"path":"Observation.method","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationMethod"}],"strength":"example","description":"Methods for simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-methods"},"mapping":[{"identity":"v2","map":"OBX-17"},{"identity":"rim","map":"methodCode"}]},{"id":"Observation.specimen","path":"Observation.specimen","short":"Specimen used for this observation","definition":"The specimen that was used when this observation was made.","comment":"Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).","min":0,"max":"1","base":{"path":"Observation.specimen","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Specimen","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-9","severity":"error","human":"If Observation.specimen is a reference to Group, the group can only have specimens","expression":"(reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123038009 |Specimen|"},{"identity":"v2","map":"SPM segment"},{"identity":"rim","map":"participation[typeCode=SPC].specimen"},{"identity":"sct-attr","map":"704319004 |Inherent in|"}]},{"id":"Observation.device","path":"Observation.device","short":"A reference to the device that generates the measurements or the device settings for the device","definition":"A reference to the device that generates the measurements or the device settings for the device.","comment":"Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.","min":0,"max":"1","base":{"path":"Observation.device","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 49062001 |Device|"},{"identity":"v2","map":"OBX-17 / PRT -10"},{"identity":"rim","map":"participation[typeCode=DEV]"},{"identity":"sct-attr","map":"424226004 |Using device|"}]},{"id":"Observation.referenceRange","path":"Observation.referenceRange","short":"Provides guide for interpretation","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.referenceRange","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-3","severity":"error","human":"Must have at least a low or a high or text","expression":"low.exists() or high.exists() or text.exists()","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]},{"id":"Observation.referenceRange.id","path":"Observation.referenceRange.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.extension","path":"Observation.referenceRange.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.modifierExtension","path":"Observation.referenceRange.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.referenceRange.low","path":"Observation.referenceRange.low","short":"Low Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.low","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.low"}]},{"id":"Observation.referenceRange.high","path":"Observation.referenceRange.high","short":"High Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.high","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.high"}]},{"id":"Observation.referenceRange.normalValue","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.normalValue","short":"Normal value, if relevant","definition":"The value of the normal value of the reference range.","min":0,"max":"1","base":{"path":"Observation.referenceRange.normalValue","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationReferenceRangeNormalValue"}],"strength":"extensible","description":"Codes identifying the normal value of the observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue"},"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.normal"}]},{"id":"Observation.referenceRange.type","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.type","short":"Reference range qualifier","definition":"Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.","requirements":"Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.","min":0,"max":"1","base":{"path":"Observation.referenceRange.type","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeMeaning"}],"strength":"preferred","description":"Code for the meaning of a reference range.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-meaning"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.appliesTo","path":"Observation.referenceRange.appliesTo","short":"Reference range population","definition":"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.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.","requirements":"Need to be able to identify the target population for proper interpretation.","min":0,"max":"*","base":{"path":"Observation.referenceRange.appliesTo","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeType"}],"strength":"example","description":"Codes identifying the population the reference range applies to.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-appliesto"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.age","path":"Observation.referenceRange.age","short":"Applicable age range, if relevant","definition":"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.","requirements":"Some analytes vary greatly over age.","min":0,"max":"1","base":{"path":"Observation.referenceRange.age","min":0,"max":"1"},"type":[{"code":"Range"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}]},{"id":"Observation.referenceRange.text","path":"Observation.referenceRange.text","short":"Text based reference range in an observation","definition":"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\".","min":0,"max":"1","base":{"path":"Observation.referenceRange.text","min":0,"max":"1"},"type":[{"code":"markdown"}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:ST"}]},{"id":"Observation.hasMember","path":"Observation.hasMember","short":"Used when reporting vital signs panel components","definition":"Used when reporting vital signs panel components.","comment":"When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.","min":0,"max":"*","base":{"path":"Observation.hasMember","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.derivedFrom","path":"Observation.derivedFrom","short":"Related resource from which the observation is made","definition":"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.","comment":"All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.","min":0,"max":"*","base":{"path":"Observation.derivedFrom","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":".targetObservation"}]},{"id":"Observation.component","path":"Observation.component","short":"Used when reporting systolic and diastolic blood pressure.","definition":"Used when reporting systolic and diastolic blood pressure.","comment":"For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.","requirements":"Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.","min":0,"max":"*","base":{"path":"Observation.component","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"vs-3","severity":"error","human":"If there is no a value a data absent reason must be present","expression":"value.exists() or dataAbsentReason.exists()","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"containment by OBX-4?"},{"identity":"rim","map":"outBoundRelationship[typeCode=COMP]"}]},{"id":"Observation.component.id","path":"Observation.component.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.extension","path":"Observation.component.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.modifierExtension","path":"Observation.component.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.component.code","path":"Observation.component.code","short":"Type of component observation (code / type)","definition":"Describes what was observed. Sometimes this is called the observation \"code\".","comment":"*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","min":1,"max":"1","base":{"path":"Observation.component.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"}]},{"id":"Observation.component.value[x]","path":"Observation.component.value[x]","slicing":{"discriminator":[{"type":"type","path":"$this"}],"ordered":false,"rules":"open"},"short":"Vital Sign Value","definition":"Vital Sign Value.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.component.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["vs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.value[x]:valueQuantity","path":"Observation.component.value[x]","sliceName":"valueQuantity","short":"Vital Sign Value recorded with UCUM","definition":"Vital Sign Value recorded with UCUM.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","min":0,"max":"1","base":{"path":"Observation.component.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for recording Vital Signs."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSignsUnits"}],"strength":"required","description":"Commonly encountered UCUM units for recording Vital Signs.","valueSet":"http://hl7.org/fhir/ValueSet/ucum-vitals-common"},"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.dataAbsentReason","path":"Observation.component.dataAbsentReason","short":"Why the component result is missing","definition":"Provides a reason why the expected value in the element Observation.component.value[x] is missing.","comment":"\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.component.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["vs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.component.interpretation","path":"Observation.component.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.component.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.component.referenceRange","path":"Observation.component.referenceRange","short":"Provides guide for interpretation of component result","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.component.referenceRange","min":0,"max":"*"},"contentReference":"http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]}]},"differential":{"element":[{"id":"Observation","path":"Observation","short":"FHIR Body Height Profile","definition":"This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure.","min":0,"max":"*"},{"id":"Observation.code","path":"Observation.code","short":"Body Height","definition":"Body Height.","comment":"additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.","alias":["Test","Name"]},{"id":"Observation.code.coding","path":"Observation.code.coding","slicing":{"discriminator":[{"type":"value","path":"code"},{"type":"value","path":"system"}],"ordered":false,"rules":"open"}},{"id":"Observation.code.coding:BodyHeightCode","path":"Observation.code.coding","sliceName":"BodyHeightCode","min":1,"max":"1"},{"id":"Observation.code.coding:BodyHeightCode.system","path":"Observation.code.coding.system","min":1,"max":"1","type":[{"code":"uri"}],"fixedUri":"http://loinc.org"},{"id":"Observation.code.coding:BodyHeightCode.code","path":"Observation.code.coding.code","min":1,"max":"1","type":[{"code":"code"}],"fixedCode":"8302-2"},{"id":"Observation.valueQuantity","path":"Observation.valueQuantity"},{"id":"Observation.valueQuantity.value","path":"Observation.valueQuantity.value","min":1,"max":"1","type":[{"code":"decimal"}],"mustSupport":true},{"id":"Observation.valueQuantity.unit","path":"Observation.valueQuantity.unit","min":1,"max":"1","type":[{"code":"string"}],"mustSupport":true},{"id":"Observation.valueQuantity.system","path":"Observation.valueQuantity.system","min":1,"max":"1","type":[{"code":"uri"}],"fixedUri":"http://unitsofmeasure.org","mustSupport":true},{"id":"Observation.valueQuantity.code","path":"Observation.valueQuantity.code","short":"Coded responses from the common UCUM units for vital signs value set.","definition":"Coded responses from the common UCUM units for vital signs value set.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for body length measures such as Body Height and Head Circumference."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodyLengthUnits"}],"strength":"required","description":"cm | [in_i]","valueSet":"http://hl7.org/fhir/ValueSet/ucum-bodylength"}}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyweight.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyweight.json index bf74739c9..5e98b96d1 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyweight.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-bodyweight.json @@ -1,3930 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "bodyweight", - "text" : { - "status" : "generated", - "div" : "
to do
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary", - "valueMarkdown" : "#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'29463-7'**\r - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have an system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'kg', 'g', or '[lb_av]'**" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 5 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "oo" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }, - { - "url" : "http://hl7.org/fhir/build/StructureDefinition/summary", - "valueString" : "#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'29463-7'**\r - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have an system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'kg', 'g', or '[lb_av]'**" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/bodyweight", - "version" : "4.6.0", - "name" : "observation-bodyweight", - "title" : "Observation Body Weight Profile", - "status" : "draft", - "experimental" : false, - "date" : "2018-08-11", - "publisher" : "Health Level Seven International (Orders and Observations Workgroup)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/orders/index.cfm Orders and Observations" - }] - }], - "description" : "FHIR Body Weight Profile", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "workflow", - "uri" : "http://hl7.org/fhir/workflow", - "name" : "Workflow Pattern" - }, - { - "identity" : "sct-concept", - "uri" : "http://snomed.info/conceptdomain", - "name" : "SNOMED CT Concept Domain Binding" - }, - { - "identity" : "v2", - "uri" : "http://hl7.org/v2", - "name" : "HL7 v2 Mapping" - }, - { - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }, - { - "identity" : "sct-attr", - "uri" : "http://snomed.org/attributebinding", - "name" : "SNOMED CT Attribute Binding" - }], - "kind" : "resource", - "abstract" : false, - "type" : "Observation", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/vitalsigns", - "derivation" : "constraint", - "snapshot" : { - "element" : [{ - "id" : "Observation", - "path" : "Observation", - "short" : "FHIR Body Weight Profile", - "definition" : "This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure.", - "comment" : "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.", - "alias" : ["Vital Signs", - "Measurement", - "Results", - "Tests"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation", - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "obs-6", - "severity" : "error", - "human" : "dataAbsentReason SHALL only be present if Observation.value[x] is not present", - "expression" : "dataAbsentReason.empty() or value.empty()", - "xpath" : "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }, - { - "key" : "obs-7", - "severity" : "error", - "human" : "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", - "expression" : "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", - "xpath" : "not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }, - { - "key" : "vs-2", - "severity" : "error", - "human" : "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", - "expression" : "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", - "xpath" : "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "workflow", - "map" : "Event" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity|" - }, - { - "identity" : "v2", - "map" : "OBX" - }, - { - "identity" : "rim", - "map" : "Observation[classCode=OBS, moodCode=EVN]" - }, - { - "identity" : "w5", - "map" : "clinical.diagnostics" - }] - }, - { - "id" : "Observation.id", - "path" : "Observation.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Observation.meta", - "path" : "Observation.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Observation.implicitRules", - "path" : "Observation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "Observation.language", - "path" : "Observation.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "Observation.text", - "path" : "Observation.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "Observation.contained", - "path" : "Observation.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.extension", - "path" : "Observation.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.modifierExtension", - "path" : "Observation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.identifier", - "path" : "Observation.identifier", - "short" : "Business Identifier for observation", - "definition" : "A unique identifier assigned to this observation.", - "requirements" : "Allows observations to be distinguished and referenced.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "v2", - "map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4." - }, - { - "identity" : "rim", - "map" : "id" - }] - }, - { - "id" : "Observation.instantiates[x]", - "path" : "Observation.instantiates[x]", - "short" : "Instantiates FHIR ObservationDefinition", - "definition" : "The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.", - "comment" : "ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.instantiates[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"] - }, - { - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.instantiatesCanonical" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "Observation.basedOn", - "path" : "Observation.basedOn", - "short" : "Fulfills plan, proposal or order", - "definition" : "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.", - "requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", - "alias" : ["Fulfills"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.basedOn", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan", - "http://hl7.org/fhir/StructureDefinition/DeviceRequest", - "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", - "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "http://hl7.org/fhir/StructureDefinition/NutritionOrder", - "http://hl7.org/fhir/StructureDefinition/ServiceRequest"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.basedOn" - }, - { - "identity" : "v2", - "map" : "ORC" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" - }] - }, - { - "id" : "Observation.partOf", - "path" : "Observation.partOf", - "short" : "Part of referenced event", - "definition" : "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", - "comment" : "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", - "alias" : ["Container"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.partOf", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration", - "http://hl7.org/fhir/StructureDefinition/MedicationDispense", - "http://hl7.org/fhir/StructureDefinition/MedicationUsage", - "http://hl7.org/fhir/StructureDefinition/Procedure", - "http://hl7.org/fhir/StructureDefinition/Immunization", - "http://hl7.org/fhir/StructureDefinition/ImagingStudy"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.partOf" - }, - { - "identity" : "v2", - "map" : "Varies by domain" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=FLFS].target" - }] - }, - { - "id" : "Observation.status", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", - "valueString" : "default: final" - }], - "path" : "Observation.status", - "short" : "registered | preliminary | final | amended +", - "definition" : "The status of the result value.", - "comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", - "requirements" : "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.status", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "Status" - }], - "strength" : "required", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-status" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.status" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "sct-concept", - "map" : "< 445584004 |Report by finality status|" - }, - { - "identity" : "v2", - "map" : "OBX-11" - }, - { - "identity" : "rim", - "map" : "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\"" - }] - }, - { - "id" : "Observation.category", - "path" : "Observation.category", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "coding.code" - }, - { - "type" : "value", - "path" : "coding.system" - }], - "ordered" : false, - "rules" : "open" - }, - "short" : "Classification of type of observation", - "definition" : "A code that classifies the general type of observation being made.", - "comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.", - "requirements" : "Used for filtering what observations are retrieved and displayed.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "Observation.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationCategory" - }], - "strength" : "preferred", - "description" : "Codes for high level observation categories.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" - }] - }, - { - "id" : "Observation.category:VSCat", - "path" : "Observation.category", - "sliceName" : "VSCat", - "short" : "Classification of type of observation", - "definition" : "A code that classifies the general type of observation being made.", - "comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.", - "requirements" : "Used for filtering what observations are retrieved and displayed.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationCategory" - }], - "strength" : "preferred", - "description" : "Codes for high level observation categories.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" - }] - }, - { - "id" : "Observation.category:VSCat.id", - "path" : "Observation.category.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.extension", - "path" : "Observation.category.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding", - "path" : "Observation.category.coding", - "short" : "Code defined by a terminology system", - "definition" : "A reference to a code defined by a terminology system.", - "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", - "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "CodeableConcept.coding", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1-8, C*E.10-22" - }, - { - "identity" : "rim", - "map" : "union(., ./translation)" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" - }] - }, - { - "id" : "Observation.category:VSCat.coding.id", - "path" : "Observation.category.coding.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding.extension", - "path" : "Observation.category.coding.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding.system", - "path" : "Observation.category.coding.system", - "short" : "Identity of the terminology system", - "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", - "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", - "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.system", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://terminology.hl7.org/CodeSystem/observation-category", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.3" - }, - { - "identity" : "rim", - "map" : "./codeSystem" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" - }] - }, - { - "id" : "Observation.category:VSCat.coding.version", - "path" : "Observation.category.coding.version", - "short" : "Version of the system - if relevant", - "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", - "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.version", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.7" - }, - { - "identity" : "rim", - "map" : "./codeSystemVersion" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" - }] - }, - { - "id" : "Observation.category:VSCat.coding.code", - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/no-binding", - "valueBoolean" : true - }], - "path" : "Observation.category.coding.code", - "short" : "Symbol in syntax defined by the system", - "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", - "requirements" : "Need to refer to a particular code in the system.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "fixedCode" : "vital-signs", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1" - }, - { - "identity" : "rim", - "map" : "./code" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" - }] - }, - { - "id" : "Observation.category:VSCat.coding.display", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.category.coding.display", - "short" : "Representation defined by the system", - "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", - "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.display", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.2 - but note this is not well followed" - }, - { - "identity" : "rim", - "map" : "CV.displayName" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" - }] - }, - { - "id" : "Observation.category:VSCat.coding.userSelected", - "path" : "Observation.category.coding.userSelected", - "short" : "If this coding was chosen directly by the user", - "definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", - "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", - "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.userSelected", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Sometimes implied by being first" - }, - { - "identity" : "rim", - "map" : "CD.codingRationale" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" - }] - }, - { - "id" : "Observation.category:VSCat.text", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.category.text", - "short" : "Plain text representation of the concept", - "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", - "comment" : "Very often the text is the same as a displayName of one of the codings.", - "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CodeableConcept.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.9. But note many systems use C*E.2 for this" - }, - { - "identity" : "rim", - "map" : "./originalText[mediaType/code=\"text/plain\"]/data" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" - }] - }, - { - "id" : "Observation.code", - "path" : "Observation.code", - "short" : "Body Weight", - "definition" : "Body Weight.", - "comment" : "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", - "requirements" : "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", - "alias" : ["Name", - "Test"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.code" - }, - { - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "code" - }, - { - "identity" : "sct-attr", - "map" : "116680003 |Is a|" - }] - }, - { - "id" : "Observation.code.id", - "path" : "Observation.code.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.extension", - "path" : "Observation.code.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.coding", - "path" : "Observation.code.coding", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "code" - }, - { - "type" : "value", - "path" : "system" - }], - "ordered" : false, - "rules" : "open" - }, - "short" : "Code defined by a terminology system", - "definition" : "A reference to a code defined by a terminology system.", - "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", - "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "CodeableConcept.coding", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1-8, C*E.10-22" - }, - { - "identity" : "rim", - "map" : "union(., ./translation)" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode", - "path" : "Observation.code.coding", - "sliceName" : "BodyWeightCode", - "short" : "Code defined by a terminology system", - "definition" : "A reference to a code defined by a terminology system.", - "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", - "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "CodeableConcept.coding", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1-8, C*E.10-22" - }, - { - "identity" : "rim", - "map" : "union(., ./translation)" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode.id", - "path" : "Observation.code.coding.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode.extension", - "path" : "Observation.code.coding.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode.system", - "path" : "Observation.code.coding.system", - "short" : "Identity of the terminology system", - "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", - "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", - "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.system", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://loinc.org", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.3" - }, - { - "identity" : "rim", - "map" : "./codeSystem" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode.version", - "path" : "Observation.code.coding.version", - "short" : "Version of the system - if relevant", - "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", - "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.version", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.7" - }, - { - "identity" : "rim", - "map" : "./codeSystemVersion" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode.code", - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/no-binding", - "valueBoolean" : true - }], - "path" : "Observation.code.coding.code", - "short" : "Symbol in syntax defined by the system", - "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", - "requirements" : "Need to refer to a particular code in the system.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "fixedCode" : "29463-7", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1" - }, - { - "identity" : "rim", - "map" : "./code" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode.display", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.code.coding.display", - "short" : "Representation defined by the system", - "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", - "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.display", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.2 - but note this is not well followed" - }, - { - "identity" : "rim", - "map" : "CV.displayName" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" - }] - }, - { - "id" : "Observation.code.coding:BodyWeightCode.userSelected", - "path" : "Observation.code.coding.userSelected", - "short" : "If this coding was chosen directly by the user", - "definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", - "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", - "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.userSelected", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Sometimes implied by being first" - }, - { - "identity" : "rim", - "map" : "CD.codingRationale" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" - }] - }, - { - "id" : "Observation.code.text", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.code.text", - "short" : "Plain text representation of the concept", - "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", - "comment" : "Very often the text is the same as a displayName of one of the codings.", - "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CodeableConcept.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.9. But note many systems use C*E.2 for this" - }, - { - "identity" : "rim", - "map" : "./originalText[mediaType/code=\"text/plain\"]/data" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" - }] - }, - { - "id" : "Observation.subject", - "path" : "Observation.subject", - "short" : "Who and/or what the observation is about", - "definition" : "The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.", - "comment" : "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).", - "requirements" : "Observations have no value if you don't know who or what they're about.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.subject", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.subject" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=RTGT]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "Observation.focus", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "path" : "Observation.focus", - "short" : "What the observation is about, when it is not about the subject of record", - "definition" : "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.", - "comment" : "Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [focusCode](extension-observation-focuscode.html).", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.focus", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=SBJ]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "Observation.encounter", - "path" : "Observation.encounter", - "short" : "Healthcare event during which this observation is made", - "definition" : "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", - "comment" : "This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).", - "requirements" : "For some observations it may be important to know the link between an observation and a particular encounter.", - "alias" : ["Context"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.encounter", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.context" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "PV1" - }, - { - "identity" : "rim", - "map" : "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" - }] - }, - { - "id" : "Observation.effective[x]", - "path" : "Observation.effective[x]", - "short" : "Often just a dateTime for Vital Signs", - "definition" : "Often just a dateTime for Vital Signs.", - "comment" : "At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.", - "requirements" : "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", - "alias" : ["Occurrence"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.effective[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }, - { - "code" : "Period" - }], - "condition" : ["vs-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "vs-1", - "severity" : "error", - "human" : "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", - "expression" : "($this as dateTime).toString().length() >= 8", - "xpath" : "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.occurrence[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.done[x]" - }, - { - "identity" : "v2", - "map" : "OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)" - }, - { - "identity" : "rim", - "map" : "effectiveTime" - }] - }, - { - "id" : "Observation.issued", - "path" : "Observation.issued", - "short" : "Date/Time this version was made available", - "definition" : "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", - "comment" : "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.issued", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "instant" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "v2", - "map" : "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=AUT].time" - }] - }, - { - "id" : "Observation.performer", - "path" : "Observation.performer", - "short" : "Who is responsible for the observation", - "definition" : "Who was responsible for asserting the observed value as \"true\".", - "requirements" : "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.performer", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/CareTeam", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.performer.actor" - }, - { - "identity" : "w5", - "map" : "FiveWs.actor" - }, - { - "identity" : "v2", - "map" : "OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=PRF]" - }] - }, - { - "id" : "Observation.value[x]", - "path" : "Observation.value[x]", - "slicing" : { - "discriminator" : [{ - "type" : "type", - "path" : "$this" - }], - "ordered" : false, - "rules" : "closed" - }, - "short" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "definition" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "comment" : "- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }], - "condition" : ["obs-7", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity", - "path" : "Observation.value[x]", - "sliceName" : "valueQuantity", - "short" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "definition" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "comment" : "- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }], - "condition" : ["obs-7", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.id", - "path" : "Observation.value[x].id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.extension", - "path" : "Observation.value[x].extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.value", - "path" : "Observation.value[x].value", - "short" : "Numerical value (with implicit precision)", - "definition" : "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", - "comment" : "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", - "requirements" : "Precision is handled implicitly in almost all cases of measurement.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.value", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "decimal" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "SN.2 / CQ - N/A" - }, - { - "identity" : "rim", - "map" : "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.comparator", - "path" : "Observation.value[x].comparator", - "short" : "< | <= | >= | > | ad - how to understand the value", - "definition" : "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", - "requirements" : "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Quantity.comparator", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "meaningWhenMissing" : "If there is no comparator, then there is no modification of the value", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : true, - "isModifierReason" : "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "How the Quantity should be understood and represented." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "QuantityComparator" - }], - "strength" : "required", - "valueSet" : "http://hl7.org/fhir/ValueSet/quantity-comparator|4.6.0" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "SN.1 / CQ.1" - }, - { - "identity" : "rim", - "map" : "IVL properties" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.unit", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.value[x].unit", - "short" : "Unit representation", - "definition" : "A human-readable form of the unit.", - "requirements" : "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.unit", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "(see OBX.6 etc.) / CQ.2" - }, - { - "identity" : "rim", - "map" : "PQ.unit" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.system", - "path" : "Observation.value[x].system", - "short" : "System that defines coded unit form", - "definition" : "The identification of the system that provides the coded form of the unit.", - "requirements" : "Need to know the system that defines the coded form of the unit.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.system", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://unitsofmeasure.org", - "condition" : ["qty-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "(see OBX.6 etc.) / CQ.2" - }, - { - "identity" : "rim", - "map" : "CO.codeSystem, PQ.translation.codeSystem" - }] - }, - { - "id" : "Observation.value[x]:valueQuantity.code", - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/no-binding", - "valueBoolean" : true - }], - "path" : "Observation.value[x].code", - "short" : "Coded responses from the common UCUM units for vital signs value set.", - "definition" : "Coded responses from the common UCUM units for vital signs value set.", - "comment" : "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", - "requirements" : "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Quantity.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for Body Weight." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodyWeightUnits" - }], - "strength" : "required", - "description" : "g | kg | [lb_av]", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-bodyweight" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "(see OBX.6 etc.) / CQ.2" - }, - { - "identity" : "rim", - "map" : "PQ.code, MO.currency, PQ.translation.code" - }] - }, - { - "id" : "Observation.dataAbsentReason", - "path" : "Observation.dataAbsentReason", - "short" : "Why the result is missing", - "definition" : "Provides a reason why the expected value in the element Observation.value[x] is missing.", - "comment" : "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.", - "requirements" : "For many results it is necessary to handle exceptional values in measurements.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.dataAbsentReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["obs-6", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationValueAbsentReason" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Codes specifying why the result (`Observation.value[x]`) is missing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "N/A" - }, - { - "identity" : "rim", - "map" : "value.nullFlavor" - }] - }, - { - "id" : "Observation.interpretation", - "path" : "Observation.interpretation", - "short" : "High, low, normal, etc.", - "definition" : "A categorical assessment of an observation value. For example, high, low, normal.", - "comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", - "requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", - "alias" : ["Abnormal Flag"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.interpretation", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationInterpretation" - }], - "strength" : "extensible", - "description" : "Codes identifying interpretations of observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values|" - }, - { - "identity" : "v2", - "map" : "OBX-8" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }, - { - "identity" : "sct-attr", - "map" : "363713009 |Has interpretation|" - }] - }, - { - "id" : "Observation.note", - "path" : "Observation.note", - "short" : "Comments about the observation", - "definition" : "Comments about the observation or the results.", - "comment" : "May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.", - "requirements" : "Need to be able to provide free text additional information.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.note", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)" - }, - { - "identity" : "rim", - "map" : "subjectOf.observationEvent[code=\"annotation\"].value" - }] - }, - { - "id" : "Observation.bodySite", - "path" : "Observation.bodySite", - "short" : "Observed body part", - "definition" : "Indicates the site on the subject's body where the observation was made (i.e. the target site).", - "comment" : "Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.bodySite", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Codes describing anatomical locations. May include laterality." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodySite" - }], - "strength" : "example", - "description" : "SNOMED CT Body site concepts", - "valueSet" : "http://hl7.org/fhir/ValueSet/body-site" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 123037004 |Body structure|" - }, - { - "identity" : "v2", - "map" : "OBX-20" - }, - { - "identity" : "rim", - "map" : "targetSiteCode" - }, - { - "identity" : "sct-attr", - "map" : "718497002 |Inherent location|" - }] - }, - { - "id" : "Observation.method", - "path" : "Observation.method", - "short" : "How it was done", - "definition" : "Indicates the mechanism used to perform the observation.", - "comment" : "Only used if not implicit in code for Observation.code.", - "requirements" : "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.method", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationMethod" - }], - "strength" : "example", - "description" : "Methods for simple observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-17" - }, - { - "identity" : "rim", - "map" : "methodCode" - }] - }, - { - "id" : "Observation.specimen", - "path" : "Observation.specimen", - "short" : "Specimen used for this observation", - "definition" : "The specimen that was used when this observation was made.", - "comment" : "Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.specimen", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 123038009 |Specimen|" - }, - { - "identity" : "v2", - "map" : "SPM segment" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=SPC].specimen" - }, - { - "identity" : "sct-attr", - "map" : "704319004 |Inherent in|" - }] - }, - { - "id" : "Observation.device", - "path" : "Observation.device", - "short" : "(Measurement) Device", - "definition" : "The device used to generate the observation data.", - "comment" : "Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.device", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/DeviceMetric"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 49062001 |Device|" - }, - { - "identity" : "v2", - "map" : "OBX-17 / PRT -10" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=DEV]" - }, - { - "identity" : "sct-attr", - "map" : "424226004 |Using device|" - }] - }, - { - "id" : "Observation.referenceRange", - "path" : "Observation.referenceRange", - "short" : "Provides guide for interpretation", - "definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.", - "comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", - "requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.referenceRange", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "obs-3", - "severity" : "error", - "human" : "Must have at least a low or a high or text", - "expression" : "low.exists() or high.exists() or text.exists()", - "xpath" : "(exists(f:low) or exists(f:high)or exists(f:text))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX.7" - }, - { - "identity" : "rim", - "map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" - }] - }, - { - "id" : "Observation.referenceRange.id", - "path" : "Observation.referenceRange.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.referenceRange.extension", - "path" : "Observation.referenceRange.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.referenceRange.modifierExtension", - "path" : "Observation.referenceRange.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.referenceRange.low", - "path" : "Observation.referenceRange.low", - "short" : "Low Range, if relevant", - "definition" : "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).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.low", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "condition" : ["obs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:IVL_PQ.low" - }] - }, - { - "id" : "Observation.referenceRange.high", - "path" : "Observation.referenceRange.high", - "short" : "High Range, if relevant", - "definition" : "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).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.high", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "condition" : ["obs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:IVL_PQ.high" - }] - }, - { - "id" : "Observation.referenceRange.type", - "path" : "Observation.referenceRange.type", - "short" : "Reference range qualifier", - "definition" : "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", - "comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", - "requirements" : "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.type", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationRangeMeaning" - }], - "strength" : "preferred", - "description" : "Code for the meaning of a reference range.", - "valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|" - }, - { - "identity" : "v2", - "map" : "OBX-10" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }] - }, - { - "id" : "Observation.referenceRange.appliesTo", - "path" : "Observation.referenceRange.appliesTo", - "short" : "Reference range population", - "definition" : "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.", - "comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", - "requirements" : "Need to be able to identify the target population for proper interpretation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.referenceRange.appliesTo", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationRangeType" - }], - "strength" : "example", - "description" : "Codes identifying the population the reference range applies to.", - "valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|" - }, - { - "identity" : "v2", - "map" : "OBX-10" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }] - }, - { - "id" : "Observation.referenceRange.age", - "path" : "Observation.referenceRange.age", - "short" : "Applicable age range, if relevant", - "definition" : "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.", - "requirements" : "Some analytes vary greatly over age.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.age", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Range" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" - }] - }, - { - "id" : "Observation.referenceRange.text", - "path" : "Observation.referenceRange.text", - "short" : "Text based reference range in an observation", - "definition" : "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\".", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:ST" - }] - }, - { - "id" : "Observation.hasMember", - "path" : "Observation.hasMember", - "short" : "Used when reporting vital signs panel components", - "definition" : "Used when reporting vital signs panel components.", - "comment" : "When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.hasMember", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Relationships established by OBX-4 usage" - }, - { - "identity" : "rim", - "map" : "outBoundRelationship" - }] - }, - { - "id" : "Observation.derivedFrom", - "path" : "Observation.derivedFrom", - "short" : "Related measurements the observation is made from", - "definition" : "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.", - "comment" : "All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.derivedFrom", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference", - "http://hl7.org/fhir/StructureDefinition/ImagingStudy", - "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Relationships established by OBX-4 usage" - }, - { - "identity" : "rim", - "map" : ".targetObservation" - }] - }, - { - "id" : "Observation.component", - "path" : "Observation.component", - "short" : "Used when reporting systolic and diastolic blood pressure.", - "definition" : "Used when reporting systolic and diastolic blood pressure.", - "comment" : "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", - "requirements" : "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "vs-3", - "severity" : "error", - "human" : "If there is no a value a data absent reason must be present", - "expression" : "value.exists() or dataAbsentReason.exists()", - "xpath" : "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "containment by OBX-4?" - }, - { - "identity" : "rim", - "map" : "outBoundRelationship[typeCode=COMP]" - }] - }, - { - "id" : "Observation.component.id", - "path" : "Observation.component.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.component.extension", - "path" : "Observation.component.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.component.modifierExtension", - "path" : "Observation.component.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.component.code", - "path" : "Observation.component.code", - "short" : "Type of component observation (code / type)", - "definition" : "Describes what was observed. Sometimes this is called the observation \"code\".", - "comment" : "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", - "requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.component.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "code" - }] - }, - { - "id" : "Observation.component.value[x]", - "path" : "Observation.component.value[x]", - "short" : "Vital Sign Value recorded with UCUM", - "definition" : "Vital Sign Value recorded with UCUM.", - "comment" : "Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.component.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }, - { - "code" : "CodeableConcept" - }, - { - "code" : "string" - }, - { - "code" : "boolean" - }, - { - "code" : "integer" - }, - { - "code" : "Range" - }, - { - "code" : "Ratio" - }, - { - "code" : "SampledData" - }, - { - "code" : "time" - }, - { - "code" : "dateTime" - }, - { - "code" : "Period" - }, - { - "code" : "Attachment" - }], - "condition" : ["vs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for recording Vital Signs." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSignsUnits" - }], - "strength" : "required", - "description" : "Commonly encountered UCUM units for recording Vital Signs.", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-vitals-common" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "363714003 |Interprets| < 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.component.dataAbsentReason", - "path" : "Observation.component.dataAbsentReason", - "short" : "Why the component result is missing", - "definition" : "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", - "comment" : "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.", - "requirements" : "For many results it is necessary to handle exceptional values in measurements.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.component.dataAbsentReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["obs-6", - "vs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationValueAbsentReason" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Codes specifying why the result (`Observation.value[x]`) is missing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "N/A" - }, - { - "identity" : "rim", - "map" : "value.nullFlavor" - }] - }, - { - "id" : "Observation.component.interpretation", - "path" : "Observation.component.interpretation", - "short" : "High, low, normal, etc.", - "definition" : "A categorical assessment of an observation value. For example, high, low, normal.", - "comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", - "requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", - "alias" : ["Abnormal Flag"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component.interpretation", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationInterpretation" - }], - "strength" : "extensible", - "description" : "Codes identifying interpretations of observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values|" - }, - { - "identity" : "v2", - "map" : "OBX-8" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }, - { - "identity" : "sct-attr", - "map" : "363713009 |Has interpretation|" - }] - }, - { - "id" : "Observation.component.referenceRange", - "path" : "Observation.component.referenceRange", - "short" : "Provides guide for interpretation of component result", - "definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range.", - "comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", - "requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component.referenceRange", - "min" : 0, - "max" : "*" - }, - "contentReference" : "http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX.7" - }, - { - "identity" : "rim", - "map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "Observation", - "path" : "Observation", - "short" : "FHIR Body Weight Profile", - "definition" : "This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure.", - "min" : 0, - "max" : "*" - }, - { - "id" : "Observation.code", - "path" : "Observation.code", - "short" : "Body Weight", - "definition" : "Body Weight.", - "comment" : "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", - "alias" : ["Test", - "Name"] - }, - { - "id" : "Observation.code.coding", - "path" : "Observation.code.coding", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "code" - }, - { - "type" : "value", - "path" : "system" - }], - "ordered" : false, - "rules" : "open" - } - }, - { - "id" : "Observation.code.coding:BodyWeightCode", - "path" : "Observation.code.coding", - "sliceName" : "BodyWeightCode", - "min" : 1, - "max" : "1" - }, - { - "id" : "Observation.code.coding:BodyWeightCode.system", - "path" : "Observation.code.coding.system", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://loinc.org" - }, - { - "id" : "Observation.code.coding:BodyWeightCode.code", - "path" : "Observation.code.coding.code", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "fixedCode" : "29463-7" - }, - { - "id" : "Observation.valueQuantity", - "path" : "Observation.valueQuantity" - }, - { - "id" : "Observation.valueQuantity.value", - "path" : "Observation.valueQuantity.value", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "decimal" - }], - "mustSupport" : true - }, - { - "id" : "Observation.valueQuantity.unit", - "path" : "Observation.valueQuantity.unit", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "string" - }], - "mustSupport" : true - }, - { - "id" : "Observation.valueQuantity.system", - "path" : "Observation.valueQuantity.system", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://unitsofmeasure.org", - "mustSupport" : true - }, - { - "id" : "Observation.valueQuantity.code", - "path" : "Observation.valueQuantity.code", - "short" : "Coded responses from the common UCUM units for vital signs value set.", - "definition" : "Coded responses from the common UCUM units for vital signs value set.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for Body Weight." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodyWeightUnits" - }], - "strength" : "required", - "description" : "g | kg | [lb_av]", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-bodyweight" - } - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"bodyweight","text":{"status":"generated","div":"
to do
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-summary","valueMarkdown":"#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'29463-7'**\r - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have a system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'kg', 'g', or '[lb_av]'**"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"oo"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/tools/StructureDefinition/profile-summary","valueString":"#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'29463-7'**\r - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have a system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'kg', 'g', or '[lb_av]'**"}],"url":"http://hl7.org/fhir/StructureDefinition/bodyweight","identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:2.16.840.1.113883.4.642.5.1465"}],"version":"5.0.0","name":"Observationbodyweight","title":"Observation Body Weight Profile","status":"draft","experimental":false,"date":"2018-08-11","publisher":"Health Level Seven International (Orders and Observations Workgroup)","contact":[{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/orders/index.cfm Orders and Observations"}]}],"description":"FHIR Body Weight Profile","fhirVersion":"5.0.0","mapping":[{"identity":"workflow","uri":"http://hl7.org/fhir/workflow","name":"Workflow Pattern"},{"identity":"sct-concept","uri":"http://snomed.info/conceptdomain","name":"SNOMED CT Concept Domain Binding"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"sct-attr","uri":"http://snomed.org/attributebinding","name":"SNOMED CT Attribute Binding"}],"kind":"resource","abstract":false,"type":"Observation","baseDefinition":"http://hl7.org/fhir/StructureDefinition/vitalsigns","derivation":"constraint","snapshot":{"element":[{"id":"Observation","path":"Observation","short":"FHIR Body Weight Profile","definition":"This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure.","comment":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.","alias":["Vital Signs","Measurement","Results","Tests"],"min":0,"max":"*","base":{"path":"Observation","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"obs-6","severity":"error","human":"dataAbsentReason SHALL only be present if Observation.value[x] is not present","expression":"dataAbsentReason.empty() or value.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-7","severity":"error","human":"If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).","expression":"value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-8","severity":"error","human":"bodyStructure SHALL only be present if Observation.bodySite is not present","expression":"bodySite.exists() implies bodyStructure.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"vs-2","severity":"error","human":"If there is no component or hasMember element then either a value[x] or a data absent reason must be present.","expression":"(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Observation[classCode=OBS, moodCode=EVN]"},{"identity":"workflow","map":"Event"},{"identity":"w5","map":"clinical.diagnostics"},{"identity":"sct-concept","map":"< 363787002 |Observable entity|"},{"identity":"v2","map":"OBX"}]},{"id":"Observation.id","path":"Observation.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.meta","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.implicitRules","path":"Observation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Observation.language","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Observation.text","path":"Observation.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Observation.contained","path":"Observation.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.extension","path":"Observation.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.modifierExtension","path":"Observation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.identifier","path":"Observation.identifier","short":"Business Identifier for observation","definition":"A unique identifier assigned to this observation.","requirements":"Allows observations to be distinguished and referenced.","min":0,"max":"*","base":{"path":"Observation.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"OBX-21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 3) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."},{"identity":"rim","map":"id"}]},{"id":"Observation.instantiates[x]","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.instantiates[x]","short":"Instantiates FHIR ObservationDefinition","definition":"The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.","comment":"ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.","min":0,"max":"1","base":{"path":"Observation.instantiates[x]","min":0,"max":"1"},"type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"Observation.basedOn","path":"Observation.basedOn","short":"Fulfills plan, proposal or order","definition":"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.","requirements":"Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","alias":["Fulfills"],"min":0,"max":"*","base":{"path":"Observation.basedOn","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.basedOn"},{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.triggeredBy","short":"Triggering observation(s)","definition":"Identifies the observation(s) that triggered the performance of this observation.","min":0,"max":"*","base":{"path":"Observation.triggeredBy","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy.id","path":"Observation.triggeredBy.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.extension","path":"Observation.triggeredBy.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.modifierExtension","path":"Observation.triggeredBy.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.triggeredBy.observation","path":"Observation.triggeredBy.observation","short":"Triggering observation","definition":"Reference to the triggering observation.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.observation","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.triggeredBy.type","path":"Observation.triggeredBy.type","short":"reflex | repeat | re-run","definition":"The type of trigger.\nReflex | Repeat | Re-run.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TriggeredByType"}],"strength":"required","description":"The type of TriggeredBy Observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-triggeredbytype|5.0.0"},"mapping":[{"identity":"rim","map":"code"}]},{"id":"Observation.triggeredBy.reason","path":"Observation.triggeredBy.reason","short":"Reason that the observation was triggered","definition":"Provides the reason why this observation was performed as a result of the observation(s) referenced.","min":0,"max":"1","base":{"path":"Observation.triggeredBy.reason","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"annotation"}]},{"id":"Observation.partOf","path":"Observation.partOf","short":"Part of referenced event","definition":"A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.","comment":"To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.","alias":["Container"],"min":0,"max":"*","base":{"path":"Observation.partOf","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationAdministration","http://hl7.org/fhir/StructureDefinition/MedicationDispense","http://hl7.org/fhir/StructureDefinition/MedicationStatement","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Immunization","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/GenomicStudy"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.partOf"},{"identity":"v2","map":"Varies by domain"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target"}]},{"id":"Observation.status","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint","valueString":"default: final"}],"path":"Observation.status","short":"registered | preliminary | final | amended +","definition":"The status of the result value.","comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","requirements":"Need to track the status of individual results. Some results are finalized before the whole report is finalized.","min":1,"max":"1","base":{"path":"Observation.status","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Status"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/observation-status"},"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 445584004 |Report by finality status|"},{"identity":"v2","map":"OBX-11"},{"identity":"rim","map":"status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}]},{"id":"Observation.category","path":"Observation.category","slicing":{"discriminator":[{"type":"value","path":"coding.code"},{"type":"value","path":"coding.system"}],"ordered":false,"rules":"open"},"short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":1,"max":"*","base":{"path":"Observation.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.category:VSCat","path":"Observation.category","sliceName":"VSCat","short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":1,"max":"1","base":{"path":"Observation.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.category:VSCat.id","path":"Observation.category.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.extension","path":"Observation.category.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding","path":"Observation.category.coding","short":"Code defined by a terminology system","definition":"A reference to a code defined by a terminology system.","comment":"Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.","requirements":"Allows for alternative encodings within a code system, and translations to other code systems.","min":1,"max":"*","base":{"path":"CodeableConcept.coding","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1-8, C*E.10-22"},{"identity":"rim","map":"union(., ./translation)"},{"identity":"orim","map":"fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]},{"id":"Observation.category:VSCat.coding.id","path":"Observation.category.coding.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding.extension","path":"Observation.category.coding.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding.system","path":"Observation.category.coding.system","short":"Identity of the terminology system","definition":"The identification of the code system that defines the meaning of the symbol in the code.","comment":"The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.","requirements":"Need to be unambiguous about the source of the definition of the symbol.","min":1,"max":"1","base":{"path":"Coding.system","min":0,"max":"1"},"type":[{"code":"uri"}],"fixedUri":"http://terminology.hl7.org/CodeSystem/observation-category","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.3"},{"identity":"rim","map":"./codeSystem"},{"identity":"orim","map":"fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]},{"id":"Observation.category:VSCat.coding.version","path":"Observation.category.coding.version","short":"Version of the system - if relevant","definition":"The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.","comment":"Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.","min":0,"max":"1","base":{"path":"Coding.version","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.7"},{"identity":"rim","map":"./codeSystemVersion"},{"identity":"orim","map":"fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]},{"id":"Observation.category:VSCat.coding.code","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/no-binding","valueBoolean":true}],"path":"Observation.category.coding.code","short":"Symbol in syntax defined by the system","definition":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).","requirements":"Need to refer to a particular code in the system.","min":1,"max":"1","base":{"path":"Coding.code","min":0,"max":"1"},"type":[{"code":"code"}],"fixedCode":"vital-signs","condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1"},{"identity":"rim","map":"./code"},{"identity":"orim","map":"fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]},{"id":"Observation.category:VSCat.coding.display","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.category.coding.display","short":"Representation defined by the system","definition":"A representation of the meaning of the code in the system, following the rules of the system.","requirements":"Need to be able to carry a human-readable meaning of the code for readers that do not know the system.","min":0,"max":"1","base":{"path":"Coding.display","min":0,"max":"1"},"type":[{"code":"string"}],"condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.2 - but note this is not well followed"},{"identity":"rim","map":"CV.displayName"},{"identity":"orim","map":"fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]},{"id":"Observation.category:VSCat.coding.userSelected","path":"Observation.category.coding.userSelected","short":"If this coding was chosen directly by the user","definition":"Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).","comment":"Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.","requirements":"This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.","min":0,"max":"1","base":{"path":"Coding.userSelected","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Sometimes implied by being first"},{"identity":"rim","map":"CD.codingRationale"},{"identity":"orim","map":"fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"}]},{"id":"Observation.category:VSCat.text","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.category.text","short":"Plain text representation of the concept","definition":"A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.","comment":"Very often the text is the same as a displayName of one of the codings.","requirements":"The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.","min":0,"max":"1","base":{"path":"CodeableConcept.text","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.9. But note many systems use C*E.2 for this"},{"identity":"rim","map":"./originalText[mediaType/code=\"text/plain\"]/data"},{"identity":"orim","map":"fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"}]},{"id":"Observation.code","path":"Observation.code","short":"Body Weight","definition":"Body Weight.","comment":"additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.","requirements":"5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).","alias":["Name","Test"],"min":1,"max":"1","base":{"path":"Observation.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"},{"identity":"sct-attr","map":"116680003 |Is a|"}]},{"id":"Observation.code.id","path":"Observation.code.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.extension","path":"Observation.code.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.coding","path":"Observation.code.coding","slicing":{"discriminator":[{"type":"value","path":"code"},{"type":"value","path":"system"}],"ordered":false,"rules":"open"},"short":"Code defined by a terminology system","definition":"A reference to a code defined by a terminology system.","comment":"Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.","requirements":"Allows for alternative encodings within a code system, and translations to other code systems.","min":0,"max":"*","base":{"path":"CodeableConcept.coding","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1-8, C*E.10-22"},{"identity":"rim","map":"union(., ./translation)"},{"identity":"orim","map":"fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]},{"id":"Observation.code.coding:BodyWeightCode","path":"Observation.code.coding","sliceName":"BodyWeightCode","short":"Code defined by a terminology system","definition":"A reference to a code defined by a terminology system.","comment":"Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.","requirements":"Allows for alternative encodings within a code system, and translations to other code systems.","min":1,"max":"1","base":{"path":"CodeableConcept.coding","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1-8, C*E.10-22"},{"identity":"rim","map":"union(., ./translation)"},{"identity":"orim","map":"fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]},{"id":"Observation.code.coding:BodyWeightCode.id","path":"Observation.code.coding.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.coding:BodyWeightCode.extension","path":"Observation.code.coding.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.code.coding:BodyWeightCode.system","path":"Observation.code.coding.system","short":"Identity of the terminology system","definition":"The identification of the code system that defines the meaning of the symbol in the code.","comment":"The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.","requirements":"Need to be unambiguous about the source of the definition of the symbol.","min":1,"max":"1","base":{"path":"Coding.system","min":0,"max":"1"},"type":[{"code":"uri"}],"fixedUri":"http://loinc.org","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.3"},{"identity":"rim","map":"./codeSystem"},{"identity":"orim","map":"fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]},{"id":"Observation.code.coding:BodyWeightCode.version","path":"Observation.code.coding.version","short":"Version of the system - if relevant","definition":"The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.","comment":"Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.","min":0,"max":"1","base":{"path":"Coding.version","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.7"},{"identity":"rim","map":"./codeSystemVersion"},{"identity":"orim","map":"fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]},{"id":"Observation.code.coding:BodyWeightCode.code","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/no-binding","valueBoolean":true}],"path":"Observation.code.coding.code","short":"Symbol in syntax defined by the system","definition":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).","requirements":"Need to refer to a particular code in the system.","min":1,"max":"1","base":{"path":"Coding.code","min":0,"max":"1"},"type":[{"code":"code"}],"fixedCode":"29463-7","condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1"},{"identity":"rim","map":"./code"},{"identity":"orim","map":"fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]},{"id":"Observation.code.coding:BodyWeightCode.display","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.code.coding.display","short":"Representation defined by the system","definition":"A representation of the meaning of the code in the system, following the rules of the system.","requirements":"Need to be able to carry a human-readable meaning of the code for readers that do not know the system.","min":0,"max":"1","base":{"path":"Coding.display","min":0,"max":"1"},"type":[{"code":"string"}],"condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.2 - but note this is not well followed"},{"identity":"rim","map":"CV.displayName"},{"identity":"orim","map":"fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]},{"id":"Observation.code.coding:BodyWeightCode.userSelected","path":"Observation.code.coding.userSelected","short":"If this coding was chosen directly by the user","definition":"Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).","comment":"Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.","requirements":"This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.","min":0,"max":"1","base":{"path":"Coding.userSelected","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Sometimes implied by being first"},{"identity":"rim","map":"CD.codingRationale"},{"identity":"orim","map":"fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"}]},{"id":"Observation.code.text","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.code.text","short":"Plain text representation of the concept","definition":"A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.","comment":"Very often the text is the same as a displayName of one of the codings.","requirements":"The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.","min":0,"max":"1","base":{"path":"CodeableConcept.text","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.9. But note many systems use C*E.2 for this"},{"identity":"rim","map":"./originalText[mediaType/code=\"text/plain\"]/data"},{"identity":"orim","map":"fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"}]},{"id":"Observation.subject","path":"Observation.subject","short":"Who and/or what the observation is about","definition":"The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.","comment":"One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).","requirements":"Observations have no value if you don't know who or what they're about.","min":1,"max":"1","base":{"path":"Observation.subject","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"participation[typeCode=RTGT]"}]},{"id":"Observation.focus","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.focus","short":"What the observation is about, when it is not about the subject of record","definition":"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.","comment":"Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).","min":0,"max":"*","base":{"path":"Observation.focus","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"participation[typeCode=SBJ]"}]},{"id":"Observation.encounter","path":"Observation.encounter","short":"Healthcare event during which this observation is made","definition":"The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.","comment":"This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).","requirements":"For some observations it may be important to know the link between an observation and a particular encounter.","alias":["Context"],"min":0,"max":"1","base":{"path":"Observation.encounter","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.encounter"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1"},{"identity":"rim","map":"inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]},{"id":"Observation.effective[x]","path":"Observation.effective[x]","short":"Often just a dateTime for Vital Signs","definition":"Often just a dateTime for Vital Signs.","comment":"At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","requirements":"Knowing when an observation was deemed true is important to its relevance as well as determining trends.","alias":["Occurrence"],"min":1,"max":"1","base":{"path":"Observation.effective[x]","min":0,"max":"1"},"type":[{"code":"dateTime"},{"code":"Period"}],"condition":["vs-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"vs-1","severity":"error","human":"if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day","expression":"($this as dateTime).toString().length() >= 8","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"},{"identity":"rim","map":"effectiveTime"}]},{"id":"Observation.issued","path":"Observation.issued","short":"Date/Time this version was made available","definition":"The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","comment":"For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.","min":0,"max":"1","base":{"path":"Observation.issued","min":0,"max":"1"},"type":[{"code":"instant"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"OBR-22 (or MSH-7), or perhaps OBX-19 (depends on who observation made)"},{"identity":"rim","map":"participation[typeCode=AUT].time"}]},{"id":"Observation.performer","path":"Observation.performer","short":"Who is responsible for the observation","definition":"Who was responsible for asserting the observed value as \"true\".","requirements":"May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","min":0,"max":"*","base":{"path":"Observation.performer","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"v2","map":"OBX-15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"},{"identity":"rim","map":"participation[typeCode=PRF]"}]},{"id":"Observation.value[x]","path":"Observation.value[x]","slicing":{"discriminator":[{"type":"type","path":"$this"}],"ordered":false,"rules":"open"},"short":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","definition":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["obs-7","obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.value[x]:valueQuantity","path":"Observation.value[x]","sliceName":"valueQuantity","short":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","definition":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"}],"condition":["obs-7","obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.value[x]:valueQuantity.id","path":"Observation.value[x].id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.value[x]:valueQuantity.extension","path":"Observation.value[x].extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.value[x]:valueQuantity.value","path":"Observation.value[x].value","short":"Numerical value (with implicit precision)","definition":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.","comment":"The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).","requirements":"Precision is handled implicitly in almost all cases of measurement.","min":1,"max":"1","base":{"path":"Quantity.value","min":0,"max":"1"},"type":[{"code":"decimal"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"SN.2 / CQ - N/A"},{"identity":"rim","map":"PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"}]},{"id":"Observation.value[x]:valueQuantity.comparator","path":"Observation.value[x].comparator","short":"< | <= | >= | > | ad - how to understand the value","definition":"How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.","requirements":"Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.","min":0,"max":"1","base":{"path":"Quantity.comparator","min":0,"max":"1"},"type":[{"code":"code"}],"meaningWhenMissing":"If there is no comparator, then there is no modification of the value","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":true,"isModifierReason":"This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"How the Quantity should be understood and represented."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"QuantityComparator"}],"strength":"required","description":"How the Quantity should be understood and represented.","valueSet":"http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"},"mapping":[{"identity":"v2","map":"SN.1 / CQ.1"},{"identity":"rim","map":"IVL properties"}]},{"id":"Observation.value[x]:valueQuantity.unit","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.value[x].unit","short":"Unit representation","definition":"A human-readable form of the unit.","requirements":"There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.","min":1,"max":"1","base":{"path":"Quantity.unit","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"(see OBX.6 etc.) / CQ.2"},{"identity":"rim","map":"PQ.unit"}]},{"id":"Observation.value[x]:valueQuantity.system","path":"Observation.value[x].system","short":"System that defines coded unit form","definition":"The identification of the system that provides the coded form of the unit.","requirements":"Need to know the system that defines the coded form of the unit.","min":1,"max":"1","base":{"path":"Quantity.system","min":0,"max":"1"},"type":[{"code":"uri"}],"fixedUri":"http://unitsofmeasure.org","condition":["qty-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"(see OBX.6 etc.) / CQ.2"},{"identity":"rim","map":"CO.codeSystem, PQ.translation.codeSystem"}]},{"id":"Observation.value[x]:valueQuantity.code","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/no-binding","valueBoolean":true}],"path":"Observation.value[x].code","short":"Coded responses from the common UCUM units for vital signs value set.","definition":"Coded responses from the common UCUM units for vital signs value set.","comment":"The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.","requirements":"Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.","min":1,"max":"1","base":{"path":"Quantity.code","min":0,"max":"1"},"type":[{"code":"code"}],"condition":["qty-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for Body Weight."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodyWeightUnits"}],"strength":"required","description":"g | kg | [lb_av]","valueSet":"http://hl7.org/fhir/ValueSet/ucum-bodyweight"},"mapping":[{"identity":"v2","map":"(see OBX.6 etc.) / CQ.2"},{"identity":"rim","map":"PQ.code, MO.currency, PQ.translation.code"}]},{"id":"Observation.dataAbsentReason","path":"Observation.dataAbsentReason","short":"Why the result is missing","definition":"Provides a reason why the expected value in the element Observation.value[x] is missing.","comment":"Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.interpretation","path":"Observation.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.note","path":"Observation.note","short":"Comments about the observation","definition":"Comments about the observation or the results.","comment":"May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.","requirements":"Need to be able to provide free text additional information.","min":0,"max":"*","base":{"path":"Observation.note","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE-3 (partner NTE to OBX, or sometimes another (child?) OBX)"},{"identity":"rim","map":"subjectOf.observationEvent[code=\"annotation\"].value"}]},{"id":"Observation.bodySite","path":"Observation.bodySite","short":"Observed body part","definition":"Indicates the site on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodySite","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","description":"SNOMED CT Body site concepts","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"mapping":[{"identity":"sct-concept","map":"< 123037004 |Body structure|"},{"identity":"v2","map":"OBX-20"},{"identity":"rim","map":"targetSiteCode"},{"identity":"sct-attr","map":"718497002 |Inherent location|"}]},{"id":"Observation.bodyStructure","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.bodyStructure","short":"Observed body structure","definition":"Indicates the body structure on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodyStructure","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/BodyStructure"]}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"targetSiteCode"}]},{"id":"Observation.method","path":"Observation.method","short":"How it was done","definition":"Indicates the mechanism used to perform the observation.","comment":"Only used if not implicit in code for Observation.code.","requirements":"In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","min":0,"max":"1","base":{"path":"Observation.method","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationMethod"}],"strength":"example","description":"Methods for simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-methods"},"mapping":[{"identity":"v2","map":"OBX-17"},{"identity":"rim","map":"methodCode"}]},{"id":"Observation.specimen","path":"Observation.specimen","short":"Specimen used for this observation","definition":"The specimen that was used when this observation was made.","comment":"Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).","min":0,"max":"1","base":{"path":"Observation.specimen","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Specimen","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-9","severity":"error","human":"If Observation.specimen is a reference to Group, the group can only have specimens","expression":"(reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123038009 |Specimen|"},{"identity":"v2","map":"SPM segment"},{"identity":"rim","map":"participation[typeCode=SPC].specimen"},{"identity":"sct-attr","map":"704319004 |Inherent in|"}]},{"id":"Observation.device","path":"Observation.device","short":"A reference to the device that generates the measurements or the device settings for the device","definition":"A reference to the device that generates the measurements or the device settings for the device.","comment":"Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.","min":0,"max":"1","base":{"path":"Observation.device","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 49062001 |Device|"},{"identity":"v2","map":"OBX-17 / PRT -10"},{"identity":"rim","map":"participation[typeCode=DEV]"},{"identity":"sct-attr","map":"424226004 |Using device|"}]},{"id":"Observation.referenceRange","path":"Observation.referenceRange","short":"Provides guide for interpretation","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.referenceRange","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-3","severity":"error","human":"Must have at least a low or a high or text","expression":"low.exists() or high.exists() or text.exists()","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]},{"id":"Observation.referenceRange.id","path":"Observation.referenceRange.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.extension","path":"Observation.referenceRange.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.modifierExtension","path":"Observation.referenceRange.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.referenceRange.low","path":"Observation.referenceRange.low","short":"Low Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.low","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.low"}]},{"id":"Observation.referenceRange.high","path":"Observation.referenceRange.high","short":"High Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.high","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.high"}]},{"id":"Observation.referenceRange.normalValue","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.normalValue","short":"Normal value, if relevant","definition":"The value of the normal value of the reference range.","min":0,"max":"1","base":{"path":"Observation.referenceRange.normalValue","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationReferenceRangeNormalValue"}],"strength":"extensible","description":"Codes identifying the normal value of the observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue"},"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.normal"}]},{"id":"Observation.referenceRange.type","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.type","short":"Reference range qualifier","definition":"Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.","requirements":"Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.","min":0,"max":"1","base":{"path":"Observation.referenceRange.type","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeMeaning"}],"strength":"preferred","description":"Code for the meaning of a reference range.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-meaning"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.appliesTo","path":"Observation.referenceRange.appliesTo","short":"Reference range population","definition":"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.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.","requirements":"Need to be able to identify the target population for proper interpretation.","min":0,"max":"*","base":{"path":"Observation.referenceRange.appliesTo","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeType"}],"strength":"example","description":"Codes identifying the population the reference range applies to.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-appliesto"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.age","path":"Observation.referenceRange.age","short":"Applicable age range, if relevant","definition":"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.","requirements":"Some analytes vary greatly over age.","min":0,"max":"1","base":{"path":"Observation.referenceRange.age","min":0,"max":"1"},"type":[{"code":"Range"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}]},{"id":"Observation.referenceRange.text","path":"Observation.referenceRange.text","short":"Text based reference range in an observation","definition":"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\".","min":0,"max":"1","base":{"path":"Observation.referenceRange.text","min":0,"max":"1"},"type":[{"code":"markdown"}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:ST"}]},{"id":"Observation.hasMember","path":"Observation.hasMember","short":"Used when reporting vital signs panel components","definition":"Used when reporting vital signs panel components.","comment":"When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.","min":0,"max":"*","base":{"path":"Observation.hasMember","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.derivedFrom","path":"Observation.derivedFrom","short":"Related resource from which the observation is made","definition":"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.","comment":"All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.","min":0,"max":"*","base":{"path":"Observation.derivedFrom","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":".targetObservation"}]},{"id":"Observation.component","path":"Observation.component","short":"Used when reporting systolic and diastolic blood pressure.","definition":"Used when reporting systolic and diastolic blood pressure.","comment":"For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.","requirements":"Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.","min":0,"max":"*","base":{"path":"Observation.component","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"vs-3","severity":"error","human":"If there is no a value a data absent reason must be present","expression":"value.exists() or dataAbsentReason.exists()","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"containment by OBX-4?"},{"identity":"rim","map":"outBoundRelationship[typeCode=COMP]"}]},{"id":"Observation.component.id","path":"Observation.component.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.extension","path":"Observation.component.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.modifierExtension","path":"Observation.component.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.component.code","path":"Observation.component.code","short":"Type of component observation (code / type)","definition":"Describes what was observed. Sometimes this is called the observation \"code\".","comment":"*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","min":1,"max":"1","base":{"path":"Observation.component.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"}]},{"id":"Observation.component.value[x]","path":"Observation.component.value[x]","slicing":{"discriminator":[{"type":"type","path":"$this"}],"ordered":false,"rules":"open"},"short":"Vital Sign Value","definition":"Vital Sign Value.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.component.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["vs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.value[x]:valueQuantity","path":"Observation.component.value[x]","sliceName":"valueQuantity","short":"Vital Sign Value recorded with UCUM","definition":"Vital Sign Value recorded with UCUM.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","min":0,"max":"1","base":{"path":"Observation.component.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for recording Vital Signs."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSignsUnits"}],"strength":"required","description":"Commonly encountered UCUM units for recording Vital Signs.","valueSet":"http://hl7.org/fhir/ValueSet/ucum-vitals-common"},"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.dataAbsentReason","path":"Observation.component.dataAbsentReason","short":"Why the component result is missing","definition":"Provides a reason why the expected value in the element Observation.component.value[x] is missing.","comment":"\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.component.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["vs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.component.interpretation","path":"Observation.component.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.component.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.component.referenceRange","path":"Observation.component.referenceRange","short":"Provides guide for interpretation of component result","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.component.referenceRange","min":0,"max":"*"},"contentReference":"http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]}]},"differential":{"element":[{"id":"Observation","path":"Observation","short":"FHIR Body Weight Profile","definition":"This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure.","min":0,"max":"*"},{"id":"Observation.code","path":"Observation.code","short":"Body Weight","definition":"Body Weight.","comment":"additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.","alias":["Test","Name"]},{"id":"Observation.code.coding","path":"Observation.code.coding","slicing":{"discriminator":[{"type":"value","path":"code"},{"type":"value","path":"system"}],"ordered":false,"rules":"open"}},{"id":"Observation.code.coding:BodyWeightCode","path":"Observation.code.coding","sliceName":"BodyWeightCode","min":1,"max":"1"},{"id":"Observation.code.coding:BodyWeightCode.system","path":"Observation.code.coding.system","min":1,"max":"1","type":[{"code":"uri"}],"fixedUri":"http://loinc.org"},{"id":"Observation.code.coding:BodyWeightCode.code","path":"Observation.code.coding.code","min":1,"max":"1","type":[{"code":"code"}],"fixedCode":"29463-7"},{"id":"Observation.valueQuantity","path":"Observation.valueQuantity"},{"id":"Observation.valueQuantity.value","path":"Observation.valueQuantity.value","min":1,"max":"1","type":[{"code":"decimal"}],"mustSupport":true},{"id":"Observation.valueQuantity.unit","path":"Observation.valueQuantity.unit","min":1,"max":"1","type":[{"code":"string"}],"mustSupport":true},{"id":"Observation.valueQuantity.system","path":"Observation.valueQuantity.system","min":1,"max":"1","type":[{"code":"uri"}],"fixedUri":"http://unitsofmeasure.org","mustSupport":true},{"id":"Observation.valueQuantity.code","path":"Observation.valueQuantity.code","short":"Coded responses from the common UCUM units for vital signs value set.","definition":"Coded responses from the common UCUM units for vital signs value set.","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for Body Weight."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodyWeightUnits"}],"strength":"required","description":"g | kg | [lb_av]","valueSet":"http://hl7.org/fhir/ValueSet/ucum-bodyweight"}}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-string.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-string.json index cb243c007..2792e6703 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-string.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-string.json @@ -1,181 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "string", - "text" : { - "status" : "generated", - "div" : "
to do
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "normative" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", - "valueCode" : "4.0.0" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/string", - "version" : "4.6.0", - "name" : "string", - "status" : "active", - "date" : "2021-04-14T05:30:20+00:00", - "publisher" : "HL7 FHIR Standard", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }], - "description" : "Base StructureDefinition for string Type: A sequence of Unicode characters", - "fhirVersion" : "4.6.0", - "kind" : "primitive-type", - "abstract" : false, - "type" : "string", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/PrimitiveType", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "string", - "path" : "string", - "short" : "Primitive Type string", - "definition" : "A sequence of Unicode characters", - "comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size", - "min" : 0, - "max" : "*", - "base" : { - "path" : "string", - "min" : 0, - "max" : "*" - }, - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "string.id", - "path" : "string.id", - "representation" : ["xmlAttr"], - "short" : "xml:id (or equivalent in JSON)", - "definition" : "unique id for the element within a resource (for internal references)", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Element.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "string.extension", - "path" : "string.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "string.value", - "path" : "string.value", - "representation" : ["xmlAttr"], - "short" : "Primitive value for string", - "definition" : "The actual value", - "min" : 0, - "max" : "1", - "base" : { - "path" : "string.value", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/regex", - "valueString" : "[ \\r\\n\\t\\S]+" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "maxLength" : 1048576, - "isModifier" : false, - "isSummary" : false - }] - }, - "differential" : { - "element" : [{ - "id" : "string", - "path" : "string", - "short" : "Primitive Type string", - "definition" : "A sequence of Unicode characters", - "comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size", - "min" : 0, - "max" : "*" - }, - { - "id" : "string.value", - "path" : "string.value", - "representation" : ["xmlAttr"], - "short" : "Primitive value for string", - "definition" : "Primitive value for string", - "min" : 0, - "max" : "1", - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/regex", - "valueString" : "[ \\r\\n\\t\\S]+" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "maxLength" : 1048576 - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"string","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
to do
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"can-bind"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"has-length"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"do-translations"}],"url":"http://hl7.org/fhir/StructureDefinition/string","version":"5.0.0","name":"string","status":"active","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"HL7 FHIR Standard","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]}],"description":"string Type: A sequence of Unicode characters","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","kind":"primitive-type","abstract":false,"type":"string","baseDefinition":"http://hl7.org/fhir/StructureDefinition/PrimitiveType","derivation":"specialization","snapshot":{"element":[{"id":"string","path":"string","short":"Primitive Type string","definition":"A sequence of Unicode characters","comment":"Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size","min":0,"max":"*","base":{"path":"string","min":0,"max":"*"},"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":false},{"id":"string.id","path":"string.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","definition":"unique id for the element within a resource (for internal references)","min":0,"max":"1","base":{"path":"Element.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"isModifier":false,"isSummary":false},{"id":"string.extension","path":"string.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false},{"id":"string.value","path":"string.value","representation":["xmlAttr"],"short":"Primitive value for string","definition":"The actual value","min":0,"max":"1","base":{"path":"string.value","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"},{"url":"http://hl7.org/fhir/StructureDefinition/regex","valueString":"^[\\s\\S]+$"}],"code":"http://hl7.org/fhirpath/System.String"}],"maxLength":1048576,"isModifier":false,"isSummary":false}]},"differential":{"element":[{"id":"string","path":"string","short":"Primitive Type string","definition":"A sequence of Unicode characters","comment":"Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size","min":0,"max":"*"},{"id":"string.value","path":"string.value","representation":["xmlAttr"],"short":"Primitive value for string","definition":"Primitive value for string","min":0,"max":"1","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"},{"url":"http://hl7.org/fhir/StructureDefinition/regex","valueString":"^[\\s\\S]+$"}],"code":"http://hl7.org/fhirpath/System.String"}],"maxLength":1048576}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-uri.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-uri.json index 6c8d6017b..de92587af 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-uri.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-uri.json @@ -1,179 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "uri", - "text" : { - "status" : "generated", - "div" : "
to do
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "normative" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", - "valueCode" : "4.0.0" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/uri", - "version" : "4.6.0", - "name" : "uri", - "status" : "active", - "date" : "2021-04-14T05:30:20+00:00", - "publisher" : "HL7 FHIR Standard", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://hl7.org/fhir" - }] - }], - "description" : "Base StructureDefinition for uri Type: String of characters used to identify a name or a resource", - "fhirVersion" : "4.6.0", - "kind" : "primitive-type", - "abstract" : false, - "type" : "uri", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/PrimitiveType", - "derivation" : "specialization", - "snapshot" : { - "element" : [{ - "id" : "uri", - "path" : "uri", - "short" : "Primitive Type uri", - "definition" : "String of characters used to identify a name or a resource", - "comment" : "see http://en.wikipedia.org/wiki/Uniform_resource_identifier", - "min" : 0, - "max" : "*", - "base" : { - "path" : "uri", - "min" : 0, - "max" : "*" - }, - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "uri.id", - "path" : "uri.id", - "representation" : ["xmlAttr"], - "short" : "xml:id (or equivalent in JSON)", - "definition" : "unique id for the element within a resource (for internal references)", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Element.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "uri.extension", - "path" : "uri.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false - }, - { - "id" : "uri.value", - "path" : "uri.value", - "representation" : ["xmlAttr"], - "short" : "Primitive value for uri", - "definition" : "The actual value", - "min" : 0, - "max" : "1", - "base" : { - "path" : "uri.value", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "uri" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/regex", - "valueString" : "\\S*" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false - }] - }, - "differential" : { - "element" : [{ - "id" : "uri", - "path" : "uri", - "short" : "Primitive Type uri", - "definition" : "String of characters used to identify a name or a resource", - "comment" : "see http://en.wikipedia.org/wiki/Uniform_resource_identifier", - "min" : 0, - "max" : "*" - }, - { - "id" : "uri.value", - "path" : "uri.value", - "representation" : ["xmlAttr"], - "short" : "Primitive value for uri", - "definition" : "Primitive value for uri", - "min" : 0, - "max" : "1", - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "uri" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/regex", - "valueString" : "\\S*" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }] - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"uri","meta":{"lastUpdated":"2023-03-26T15:21:02.749+11:00"},"text":{"status":"generated","div":"
to do
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"can-bind"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics","valueCode":"has-length"}],"url":"http://hl7.org/fhir/StructureDefinition/uri","version":"5.0.0","name":"uri","status":"active","experimental":false,"date":"2023-03-26T15:21:02+11:00","publisher":"HL7 FHIR Standard","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]}],"description":"uri Type: String of characters used to identify a name or a resource","jurisdiction":[{"coding":[{"system":"http://unstats.un.org/unsd/methods/m49/m49.htm","code":"001","display":"World"}]}],"fhirVersion":"5.0.0","kind":"primitive-type","abstract":false,"type":"uri","baseDefinition":"http://hl7.org/fhir/StructureDefinition/PrimitiveType","derivation":"specialization","snapshot":{"element":[{"id":"uri","path":"uri","short":"Primitive Type uri","definition":"String of characters used to identify a name or a resource","comment":"see http://en.wikipedia.org/wiki/Uniform_resource_identifier","min":0,"max":"*","base":{"path":"uri","min":0,"max":"*"},"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":false},{"id":"uri.id","path":"uri.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","definition":"unique id for the element within a resource (for internal references)","min":0,"max":"1","base":{"path":"Element.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"isModifier":false,"isSummary":false},{"id":"uri.extension","path":"uri.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false},{"id":"uri.value","path":"uri.value","representation":["xmlAttr"],"short":"Primitive value for uri","definition":"The actual value","min":0,"max":"1","base":{"path":"uri.value","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"uri"},{"url":"http://hl7.org/fhir/StructureDefinition/regex","valueString":"\\S*"}],"code":"http://hl7.org/fhirpath/System.String"}],"isModifier":false,"isSummary":false}]},"differential":{"element":[{"id":"uri","path":"uri","short":"Primitive Type uri","definition":"String of characters used to identify a name or a resource","comment":"see http://en.wikipedia.org/wiki/Uniform_resource_identifier","min":0,"max":"*"},{"id":"uri.value","path":"uri.value","representation":["xmlAttr"],"short":"Primitive value for uri","definition":"Primitive value for uri","min":0,"max":"1","type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"uri"},{"url":"http://hl7.org/fhir/StructureDefinition/regex","valueString":"\\S*"}],"code":"http://hl7.org/fhirpath/System.String"}]}]}} \ No newline at end of file diff --git a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-vitalsigns.json b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-vitalsigns.json index a9cf65027..57bd83080 100644 --- a/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-vitalsigns.json +++ b/test/testhelpers/testdefs/r5-definitions/package/StructureDefinition-vitalsigns.json @@ -1,3267 +1 @@ -{ - "resourceType" : "StructureDefinition", - "id" : "vitalsigns", - "text" : { - "status" : "generated", - "div" : "
to do
" - }, - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary", - "valueMarkdown" : "\"#### Complete Summary of the Mandatory Requirements\n\n1. One status in `Observation.status`which has a [required](http://build.fhir.org/terminologies.html#extensible) binding to:\n - [ObservationStatus] value set.\n1. A category in `Observation.category` which must have:\n - a fixed `Observation.category.coding.system`=\"http://terminology.hl7.org/CodeSystem/observation-category\"\n - a fixed `Observation.category.coding.code`= \"vital-signs\"\n\n1. A code in `Observation.code`\n - a fixed `Observation.code.coding.system`= \"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible](http://build.fhir.org/terminologies.html#extensible) binding to:\n - [Vital Signs] value set.\n \n1. One patient in `Observation.subject`\n1. A date and time in `effectiveDateTime` or `effectivePeriod`\n1. Either one `Observation.value[x]` or, if there is no value, one code in `Observation.DataAbsentReason`\n - if a vital sign measure then:\n - One numeric value in Observation.valueQuantity.value\n - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\n - a UCUM unit code in Observation.valueQuantity.code which has an required binding to the [Vital Signs Units] value set.\n - Observation.DataAbsentReason is bound to [Observation Value\n Absent Reason] value set.\n\n1. When using a panel code to group component observations (Note: See\n the comments regarding blood pressure in the table above), one or\n more `Observation.component.code` each of which must have:\n - a fixed\n `Observation.component.code.coding.system` =\"\"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible] binding to:\n - [Vital Signs Units] value set.\n\n1. Either one `Observation.component.valueQuantity` or, if there is\n no value, one code in `Observation.component.DataAbsentReason`\n - Observation.component.DataAbsentReason is bound to [Observation\n Value Absent Reason] value set.\n\n1. When using a panel code to group observations, one or more reference\n to Vitals Signs Observations in `Observation.related.target`\n - a fixed `Observation.related.type`= \"has-member\"\"\n\n [Vital Signs]: valueset-observation-vitalsignresult.html\n [Vital Signs Units]: valueset-ucum-vitals-common.html\n [extensible]: terminologies.html#extensible\n [ObservationStatus]: valueset-observation-status.html\n [Observation Value Absent Reason]: valueset-data-absent-reason.html\n[required]: terminologies.html#required\"" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", - "valueInteger" : 5 - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", - "valueCode" : "oo" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }, - { - "url" : "http://hl7.org/fhir/build/StructureDefinition/summary", - "valueString" : "\"#### Complete Summary of the Mandatory Requirements\n\n1. One status in `Observation.status`which has a [required](http://build.fhir.org/terminologies.html#extensible) binding to:\n - [ObservationStatus] value set.\n1. A category in `Observation.category` which must have:\n - a fixed `Observation.category.coding.system`=\"http://terminology.hl7.org/CodeSystem/observation-category\"\n - a fixed `Observation.category.coding.code`= \"vital-signs\"\n\n1. A code in `Observation.code`\n - a fixed `Observation.code.coding.system`= \"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible](http://build.fhir.org/terminologies.html#extensible) binding to:\n - [Vital Signs] value set.\n \n1. One patient in `Observation.subject`\n1. A date and time in `effectiveDateTime` or `effectivePeriod`\n1. Either one `Observation.value[x]` or, if there is no value, one code in `Observation.DataAbsentReason`\n - if a vital sign measure then:\n - One numeric value in Observation.valueQuantity.value\n - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\n - a UCUM unit code in Observation.valueQuantity.code which has an required binding to the [Vital Signs Units] value set.\n - Observation.DataAbsentReason is bound to [Observation Value\n Absent Reason] value set.\n\n1. When using a panel code to group component observations (Note: See\n the comments regarding blood pressure in the table above), one or\n more `Observation.component.code` each of which must have:\n - a fixed\n `Observation.component.code.coding.system` =\"\"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible] binding to:\n - [Vital Signs Units] value set.\n\n1. Either one `Observation.component.valueQuantity` or, if there is\n no value, one code in `Observation.component.DataAbsentReason`\n - Observation.component.DataAbsentReason is bound to [Observation\n Value Absent Reason] value set.\n\n1. When using a panel code to group observations, one or more reference\n to Vitals Signs Observations in `Observation.related.target`\n - a fixed `Observation.related.type`= \"has-member\"\"\n\n [Vital Signs]: valueset-observation-vitalsignresult.html\n [Vital Signs Units]: valueset-ucum-vitals-common.html\n [extensible]: terminologies.html#extensible\n [ObservationStatus]: valueset-observation-status.html\n [Observation Value Absent Reason]: valueset-data-absent-reason.html\n[required]: terminologies.html#required\"" - }], - "url" : "http://hl7.org/fhir/StructureDefinition/vitalsigns", - "version" : "4.6.0", - "name" : "observation-vitalsigns", - "title" : "Vital Signs Profile", - "status" : "draft", - "experimental" : false, - "date" : "2016-03-25", - "publisher" : "Health Level Seven International (Orders and Observations Workgroup)", - "contact" : [{ - "telecom" : [{ - "system" : "url", - "value" : "http://www.hl7.org/Special/committees/orders/index.cfm Orders and Observations" - }] - }], - "description" : "FHIR Vital Signs Profile", - "fhirVersion" : "4.6.0", - "mapping" : [{ - "identity" : "workflow", - "uri" : "http://hl7.org/fhir/workflow", - "name" : "Workflow Pattern" - }, - { - "identity" : "sct-concept", - "uri" : "http://snomed.info/conceptdomain", - "name" : "SNOMED CT Concept Domain Binding" - }, - { - "identity" : "v2", - "uri" : "http://hl7.org/v2", - "name" : "HL7 v2 Mapping" - }, - { - "identity" : "rim", - "uri" : "http://hl7.org/v3", - "name" : "RIM Mapping" - }, - { - "identity" : "w5", - "uri" : "http://hl7.org/fhir/fivews", - "name" : "FiveWs Pattern Mapping" - }, - { - "identity" : "sct-attr", - "uri" : "http://snomed.org/attributebinding", - "name" : "SNOMED CT Attribute Binding" - }], - "kind" : "resource", - "abstract" : false, - "type" : "Observation", - "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Observation", - "derivation" : "constraint", - "snapshot" : { - "element" : [{ - "id" : "Observation", - "path" : "Observation", - "short" : "FHIR Vital Signs Profile", - "definition" : "The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient.", - "comment" : "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.", - "alias" : ["Vital Signs", - "Measurement", - "Results", - "Tests"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation", - "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" : "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", - "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", - "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "dom-5", - "severity" : "error", - "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", - "expression" : "contained.meta.security.empty()", - "xpath" : "not(exists(f:contained/*/f:meta/f:security))", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", - "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." - }], - "key" : "dom-6", - "severity" : "warning", - "human" : "A resource should have narrative for robust management", - "expression" : "text.`div`.exists()", - "xpath" : "exists(f:text/h:div)", - "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" - }, - { - "key" : "obs-6", - "severity" : "error", - "human" : "dataAbsentReason SHALL only be present if Observation.value[x] is not present", - "expression" : "dataAbsentReason.empty() or value.empty()", - "xpath" : "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }, - { - "key" : "obs-7", - "severity" : "error", - "human" : "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", - "expression" : "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", - "xpath" : "not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }, - { - "key" : "vs-2", - "severity" : "error", - "human" : "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", - "expression" : "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", - "xpath" : "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Entity. Role, or Act" - }, - { - "identity" : "workflow", - "map" : "Event" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity|" - }, - { - "identity" : "v2", - "map" : "OBX" - }, - { - "identity" : "rim", - "map" : "Observation[classCode=OBS, moodCode=EVN]" - }, - { - "identity" : "w5", - "map" : "clinical.diagnostics" - }] - }, - { - "id" : "Observation.id", - "path" : "Observation.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" : "Typically, the resource has an id except for cases like the create operation, conditional updates.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.id", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Observation.meta", - "path" : "Observation.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true - }, - { - "id" : "Observation.implicitRules", - "path" : "Observation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Resource.implicitRules", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", - "isSummary" : true - }, - { - "id" : "Observation.language", - "path" : "Observation.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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "A human language." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", - "valueCanonical" : "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" : "preferred", - "description" : "IETF language tag", - "valueSet" : "http://hl7.org/fhir/ValueSet/languages" - } - }, - { - "id" : "Observation.text", - "path" : "Observation.text", - "short" : "Text summary of the resource, for human interpretation", - "definition" : "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.", - "comment" : "Contained resources do not have a 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 information is added later.", - "alias" : ["narrative", - "html", - "xhtml", - "display"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "DomainResource.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Narrative" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "Act.text?" - }] - }, - { - "id" : "Observation.contained", - "path" : "Observation.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, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", - "alias" : ["inline resources", - "anonymous resources", - "contained resources"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.contained", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Resource" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.extension", - "path" : "Observation.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.modifierExtension", - "path" : "Observation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "DomainResource.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "mustSupport" : false, - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.identifier", - "path" : "Observation.identifier", - "short" : "Business Identifier for observation", - "definition" : "A unique identifier assigned to this observation.", - "requirements" : "Allows observations to be distinguished and referenced.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.identifier", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Identifier" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.identifier" - }, - { - "identity" : "w5", - "map" : "FiveWs.identifier" - }, - { - "identity" : "v2", - "map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4." - }, - { - "identity" : "rim", - "map" : "id" - }] - }, - { - "id" : "Observation.instantiates[x]", - "path" : "Observation.instantiates[x]", - "short" : "Instantiates FHIR ObservationDefinition", - "definition" : "The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.", - "comment" : "ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.instantiates[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "canonical", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"] - }, - { - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.instantiatesCanonical" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=DEFN].target" - }] - }, - { - "id" : "Observation.basedOn", - "path" : "Observation.basedOn", - "short" : "Fulfills plan, proposal or order", - "definition" : "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.", - "requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", - "alias" : ["Fulfills"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.basedOn", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan", - "http://hl7.org/fhir/StructureDefinition/DeviceRequest", - "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", - "http://hl7.org/fhir/StructureDefinition/MedicationRequest", - "http://hl7.org/fhir/StructureDefinition/NutritionOrder", - "http://hl7.org/fhir/StructureDefinition/ServiceRequest"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.basedOn" - }, - { - "identity" : "v2", - "map" : "ORC" - }, - { - "identity" : "rim", - "map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" - }] - }, - { - "id" : "Observation.partOf", - "path" : "Observation.partOf", - "short" : "Part of referenced event", - "definition" : "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", - "comment" : "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", - "alias" : ["Container"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.partOf", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration", - "http://hl7.org/fhir/StructureDefinition/MedicationDispense", - "http://hl7.org/fhir/StructureDefinition/MedicationUsage", - "http://hl7.org/fhir/StructureDefinition/Procedure", - "http://hl7.org/fhir/StructureDefinition/Immunization", - "http://hl7.org/fhir/StructureDefinition/ImagingStudy"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.partOf" - }, - { - "identity" : "v2", - "map" : "Varies by domain" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=FLFS].target" - }] - }, - { - "id" : "Observation.status", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", - "valueString" : "default: final" - }], - "path" : "Observation.status", - "short" : "registered | preliminary | final | amended +", - "definition" : "The status of the result value.", - "comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", - "requirements" : "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.status", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : true, - "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "Status" - }], - "strength" : "required", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-status" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.status" - }, - { - "identity" : "w5", - "map" : "FiveWs.status" - }, - { - "identity" : "sct-concept", - "map" : "< 445584004 |Report by finality status|" - }, - { - "identity" : "v2", - "map" : "OBX-11" - }, - { - "identity" : "rim", - "map" : "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\"" - }] - }, - { - "id" : "Observation.category", - "path" : "Observation.category", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "coding.code" - }, - { - "type" : "value", - "path" : "coding.system" - }], - "ordered" : false, - "rules" : "open" - }, - "short" : "Classification of type of observation", - "definition" : "A code that classifies the general type of observation being made.", - "comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.", - "requirements" : "Used for filtering what observations are retrieved and displayed.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "Observation.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationCategory" - }], - "strength" : "preferred", - "description" : "Codes for high level observation categories.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" - }] - }, - { - "id" : "Observation.category:VSCat", - "path" : "Observation.category", - "sliceName" : "VSCat", - "short" : "Classification of type of observation", - "definition" : "A code that classifies the general type of observation being made.", - "comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.", - "requirements" : "Used for filtering what observations are retrieved and displayed.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.category", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationCategory" - }], - "strength" : "preferred", - "description" : "Codes for high level observation categories.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-category" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.class" - }, - { - "identity" : "rim", - "map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" - }] - }, - { - "id" : "Observation.category:VSCat.id", - "path" : "Observation.category.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.extension", - "path" : "Observation.category.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding", - "path" : "Observation.category.coding", - "short" : "Code defined by a terminology system", - "definition" : "A reference to a code defined by a terminology system.", - "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", - "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", - "min" : 1, - "max" : "*", - "base" : { - "path" : "CodeableConcept.coding", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Coding" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1-8, C*E.10-22" - }, - { - "identity" : "rim", - "map" : "union(., ./translation)" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" - }] - }, - { - "id" : "Observation.category:VSCat.coding.id", - "path" : "Observation.category.coding.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "string" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding.extension", - "path" : "Observation.category.coding.extension", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "url" - }], - "description" : "Extensions are always sliced by (at least) url", - "rules" : "open" - }, - "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.category:VSCat.coding.system", - "path" : "Observation.category.coding.system", - "short" : "Identity of the terminology system", - "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", - "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", - "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.system", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://terminology.hl7.org/CodeSystem/observation-category", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.3" - }, - { - "identity" : "rim", - "map" : "./codeSystem" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" - }] - }, - { - "id" : "Observation.category:VSCat.coding.version", - "path" : "Observation.category.coding.version", - "short" : "Version of the system - if relevant", - "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", - "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.version", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.7" - }, - { - "identity" : "rim", - "map" : "./codeSystemVersion" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" - }] - }, - { - "id" : "Observation.category:VSCat.coding.code", - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/no-binding", - "valueBoolean" : true - }], - "path" : "Observation.category.coding.code", - "short" : "Symbol in syntax defined by the system", - "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", - "requirements" : "Need to refer to a particular code in the system.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Coding.code", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "code" - }], - "fixedCode" : "vital-signs", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.1" - }, - { - "identity" : "rim", - "map" : "./code" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" - }] - }, - { - "id" : "Observation.category:VSCat.coding.display", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.category.coding.display", - "short" : "Representation defined by the system", - "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", - "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.display", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.2 - but note this is not well followed" - }, - { - "identity" : "rim", - "map" : "CV.displayName" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" - }] - }, - { - "id" : "Observation.category:VSCat.coding.userSelected", - "path" : "Observation.category.coding.userSelected", - "short" : "If this coding was chosen directly by the user", - "definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", - "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", - "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Coding.userSelected", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "boolean" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Sometimes implied by being first" - }, - { - "identity" : "rim", - "map" : "CD.codingRationale" - }, - { - "identity" : "orim", - "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" - }] - }, - { - "id" : "Observation.category:VSCat.text", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", - "valueBoolean" : true - }], - "path" : "Observation.category.text", - "short" : "Plain text representation of the concept", - "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", - "comment" : "Very often the text is the same as a displayName of one of the codings.", - "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "CodeableConcept.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "C*E.9. But note many systems use C*E.2 for this" - }, - { - "identity" : "rim", - "map" : "./originalText[mediaType/code=\"text/plain\"]/data" - }, - { - "identity" : "orim", - "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" - }] - }, - { - "id" : "Observation.code", - "path" : "Observation.code", - "short" : "Coded Responses from C-CDA Vital Sign Results", - "definition" : "Coded Responses from C-CDA Vital Sign Results.", - "comment" : "*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", - "requirements" : "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", - "alias" : ["Name"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - }, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.code" - }, - { - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "code" - }, - { - "identity" : "sct-attr", - "map" : "116680003 |Is a|" - }] - }, - { - "id" : "Observation.subject", - "path" : "Observation.subject", - "short" : "Who and/or what the observation is about", - "definition" : "The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.", - "comment" : "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).", - "requirements" : "Observations have no value if you don't know who or what they're about.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.subject", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.subject" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "PID-3" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=RTGT]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "Observation.focus", - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", - "valueCode" : "trial-use" - }], - "path" : "Observation.focus", - "short" : "What the observation is about, when it is not about the subject of record", - "definition" : "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.", - "comment" : "Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [focusCode](extension-observation-focuscode.html).", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.focus", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.subject[x]" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=SBJ]" - }, - { - "identity" : "w5", - "map" : "FiveWs.subject" - }] - }, - { - "id" : "Observation.encounter", - "path" : "Observation.encounter", - "short" : "Healthcare event during which this observation is made", - "definition" : "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", - "comment" : "This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).", - "requirements" : "For some observations it may be important to know the link between an observation and a particular encounter.", - "alias" : ["Context"], - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.encounter", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.context" - }, - { - "identity" : "w5", - "map" : "FiveWs.context" - }, - { - "identity" : "v2", - "map" : "PV1" - }, - { - "identity" : "rim", - "map" : "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" - }] - }, - { - "id" : "Observation.effective[x]", - "path" : "Observation.effective[x]", - "short" : "Often just a dateTime for Vital Signs", - "definition" : "Often just a dateTime for Vital Signs.", - "comment" : "At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.", - "requirements" : "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", - "alias" : ["Occurrence"], - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.effective[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "dateTime" - }, - { - "code" : "Period" - }], - "condition" : ["vs-1"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "vs-1", - "severity" : "error", - "human" : "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", - "expression" : "($this as dateTime).toString().length() >= 8", - "xpath" : "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.occurrence[x]" - }, - { - "identity" : "w5", - "map" : "FiveWs.done[x]" - }, - { - "identity" : "v2", - "map" : "OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)" - }, - { - "identity" : "rim", - "map" : "effectiveTime" - }] - }, - { - "id" : "Observation.issued", - "path" : "Observation.issued", - "short" : "Date/Time this version was made available", - "definition" : "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", - "comment" : "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.issued", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "instant" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.recorded" - }, - { - "identity" : "v2", - "map" : "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=AUT].time" - }] - }, - { - "id" : "Observation.performer", - "path" : "Observation.performer", - "short" : "Who is responsible for the observation", - "definition" : "Who was responsible for asserting the observed value as \"true\".", - "requirements" : "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.performer", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner", - "http://hl7.org/fhir/StructureDefinition/PractitionerRole", - "http://hl7.org/fhir/StructureDefinition/Organization", - "http://hl7.org/fhir/StructureDefinition/CareTeam", - "http://hl7.org/fhir/StructureDefinition/Patient", - "http://hl7.org/fhir/StructureDefinition/RelatedPerson"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "workflow", - "map" : "Event.performer.actor" - }, - { - "identity" : "w5", - "map" : "FiveWs.actor" - }, - { - "identity" : "v2", - "map" : "OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=PRF]" - }] - }, - { - "id" : "Observation.value[x]", - "path" : "Observation.value[x]", - "short" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "definition" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "comment" : "- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }, - { - "code" : "CodeableConcept" - }, - { - "code" : "string" - }, - { - "code" : "boolean" - }, - { - "code" : "integer" - }, - { - "code" : "Range" - }, - { - "code" : "Ratio" - }, - { - "code" : "SampledData" - }, - { - "code" : "time" - }, - { - "code" : "dateTime" - }, - { - "code" : "Period" - }, - { - "code" : "Attachment" - }], - "condition" : ["obs-7", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.dataAbsentReason", - "path" : "Observation.dataAbsentReason", - "short" : "Why the result is missing", - "definition" : "Provides a reason why the expected value in the element Observation.value[x] is missing.", - "comment" : "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.", - "requirements" : "For many results it is necessary to handle exceptional values in measurements.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.dataAbsentReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["obs-6", - "vs-2"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationValueAbsentReason" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Codes specifying why the result (`Observation.value[x]`) is missing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "N/A" - }, - { - "identity" : "rim", - "map" : "value.nullFlavor" - }] - }, - { - "id" : "Observation.interpretation", - "path" : "Observation.interpretation", - "short" : "High, low, normal, etc.", - "definition" : "A categorical assessment of an observation value. For example, high, low, normal.", - "comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", - "requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", - "alias" : ["Abnormal Flag"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.interpretation", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationInterpretation" - }], - "strength" : "extensible", - "description" : "Codes identifying interpretations of observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values|" - }, - { - "identity" : "v2", - "map" : "OBX-8" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }, - { - "identity" : "sct-attr", - "map" : "363713009 |Has interpretation|" - }] - }, - { - "id" : "Observation.note", - "path" : "Observation.note", - "short" : "Comments about the observation", - "definition" : "Comments about the observation or the results.", - "comment" : "May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.", - "requirements" : "Need to be able to provide free text additional information.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.note", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Annotation" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)" - }, - { - "identity" : "rim", - "map" : "subjectOf.observationEvent[code=\"annotation\"].value" - }] - }, - { - "id" : "Observation.bodySite", - "path" : "Observation.bodySite", - "short" : "Observed body part", - "definition" : "Indicates the site on the subject's body where the observation was made (i.e. the target site).", - "comment" : "Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.bodySite", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Codes describing anatomical locations. May include laterality." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "BodySite" - }], - "strength" : "example", - "description" : "SNOMED CT Body site concepts", - "valueSet" : "http://hl7.org/fhir/ValueSet/body-site" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 123037004 |Body structure|" - }, - { - "identity" : "v2", - "map" : "OBX-20" - }, - { - "identity" : "rim", - "map" : "targetSiteCode" - }, - { - "identity" : "sct-attr", - "map" : "718497002 |Inherent location|" - }] - }, - { - "id" : "Observation.method", - "path" : "Observation.method", - "short" : "How it was done", - "definition" : "Indicates the mechanism used to perform the observation.", - "comment" : "Only used if not implicit in code for Observation.code.", - "requirements" : "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.method", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationMethod" - }], - "strength" : "example", - "description" : "Methods for simple observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-17" - }, - { - "identity" : "rim", - "map" : "methodCode" - }] - }, - { - "id" : "Observation.specimen", - "path" : "Observation.specimen", - "short" : "Specimen used for this observation", - "definition" : "The specimen that was used when this observation was made.", - "comment" : "Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.specimen", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 123038009 |Specimen|" - }, - { - "identity" : "v2", - "map" : "SPM segment" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=SPC].specimen" - }, - { - "identity" : "sct-attr", - "map" : "704319004 |Inherent in|" - }] - }, - { - "id" : "Observation.device", - "path" : "Observation.device", - "short" : "(Measurement) Device", - "definition" : "The device used to generate the observation data.", - "comment" : "Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.device", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device", - "http://hl7.org/fhir/StructureDefinition/DeviceMetric"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 49062001 |Device|" - }, - { - "identity" : "v2", - "map" : "OBX-17 / PRT -10" - }, - { - "identity" : "rim", - "map" : "participation[typeCode=DEV]" - }, - { - "identity" : "sct-attr", - "map" : "424226004 |Using device|" - }] - }, - { - "id" : "Observation.referenceRange", - "path" : "Observation.referenceRange", - "short" : "Provides guide for interpretation", - "definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.", - "comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", - "requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.referenceRange", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "obs-3", - "severity" : "error", - "human" : "Must have at least a low or a high or text", - "expression" : "low.exists() or high.exists() or text.exists()", - "xpath" : "(exists(f:low) or exists(f:high)or exists(f:text))", - "source" : "http://hl7.org/fhir/StructureDefinition/Observation" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX.7" - }, - { - "identity" : "rim", - "map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" - }] - }, - { - "id" : "Observation.referenceRange.id", - "path" : "Observation.referenceRange.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.referenceRange.extension", - "path" : "Observation.referenceRange.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.referenceRange.modifierExtension", - "path" : "Observation.referenceRange.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.referenceRange.low", - "path" : "Observation.referenceRange.low", - "short" : "Low Range, if relevant", - "definition" : "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).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.low", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "condition" : ["obs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:IVL_PQ.low" - }] - }, - { - "id" : "Observation.referenceRange.high", - "path" : "Observation.referenceRange.high", - "short" : "High Range, if relevant", - "definition" : "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).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.high", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity", - "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] - }], - "condition" : ["obs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:IVL_PQ.high" - }] - }, - { - "id" : "Observation.referenceRange.type", - "path" : "Observation.referenceRange.type", - "short" : "Reference range qualifier", - "definition" : "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", - "comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", - "requirements" : "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.type", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationRangeMeaning" - }], - "strength" : "preferred", - "description" : "Code for the meaning of a reference range.", - "valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|" - }, - { - "identity" : "v2", - "map" : "OBX-10" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }] - }, - { - "id" : "Observation.referenceRange.appliesTo", - "path" : "Observation.referenceRange.appliesTo", - "short" : "Reference range population", - "definition" : "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.", - "comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", - "requirements" : "Need to be able to identify the target population for proper interpretation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.referenceRange.appliesTo", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationRangeType" - }], - "strength" : "example", - "description" : "Codes identifying the population the reference range applies to.", - "valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|" - }, - { - "identity" : "v2", - "map" : "OBX-10" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }] - }, - { - "id" : "Observation.referenceRange.age", - "path" : "Observation.referenceRange.age", - "short" : "Applicable age range, if relevant", - "definition" : "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.", - "requirements" : "Some analytes vary greatly over age.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.age", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Range" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" - }] - }, - { - "id" : "Observation.referenceRange.text", - "path" : "Observation.referenceRange.text", - "short" : "Text based reference range in an observation", - "definition" : "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\".", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.referenceRange.text", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "string" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX-7" - }, - { - "identity" : "rim", - "map" : "value:ST" - }] - }, - { - "id" : "Observation.hasMember", - "path" : "Observation.hasMember", - "short" : "Used when reporting vital signs panel components", - "definition" : "Used when reporting vital signs panel components.", - "comment" : "When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.hasMember", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Relationships established by OBX-4 usage" - }, - { - "identity" : "rim", - "map" : "outBoundRelationship" - }] - }, - { - "id" : "Observation.derivedFrom", - "path" : "Observation.derivedFrom", - "short" : "Related measurements the observation is made from", - "definition" : "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.", - "comment" : "All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.derivedFrom", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference", - "http://hl7.org/fhir/StructureDefinition/ImagingStudy", - "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "Relationships established by OBX-4 usage" - }, - { - "identity" : "rim", - "map" : ".targetObservation" - }] - }, - { - "id" : "Observation.component", - "path" : "Observation.component", - "short" : "Used when reporting systolic and diastolic blood pressure.", - "definition" : "Used when reporting systolic and diastolic blood pressure.", - "comment" : "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", - "requirements" : "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "BackboneElement" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "vs-3", - "severity" : "error", - "human" : "If there is no a value a data absent reason must be present", - "expression" : "value.exists() or dataAbsentReason.exists()", - "xpath" : "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "mapping" : [{ - "identity" : "v2", - "map" : "containment by OBX-4?" - }, - { - "identity" : "rim", - "map" : "outBoundRelationship[typeCode=COMP]" - }] - }, - { - "id" : "Observation.component.id", - "path" : "Observation.component.id", - "representation" : ["xmlAttr"], - "short" : "Unique id for inter-element referencing", - "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" : [{ - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", - "valueUri" : "id" - }], - "code" : "http://hl7.org/fhirpath/System.String" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.component.extension", - "path" : "Observation.component.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "rim", - "map" : "n/a" - }] - }, - { - "id" : "Observation.component.modifierExtension", - "path" : "Observation.component.modifierExtension", - "short" : "Extensions that cannot be ignored even if unrecognized", - "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "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.", - "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", - "alias" : ["extensions", - "user content", - "modifiers"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "BackboneElement.modifierExtension", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "Extension" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }, - { - "key" : "ext-1", - "severity" : "error", - "human" : "Must have either extensions or value[x], not both", - "expression" : "extension.exists() != value.exists()", - "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", - "source" : "http://hl7.org/fhir/StructureDefinition/Extension" - }], - "isModifier" : true, - "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", - "isSummary" : true, - "mapping" : [{ - "identity" : "rim", - "map" : "N/A" - }] - }, - { - "id" : "Observation.component.code", - "path" : "Observation.component.code", - "short" : "Type of component observation (code / type)", - "definition" : "Describes what was observed. Sometimes this is called the observation \"code\".", - "comment" : "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", - "requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.", - "min" : 1, - "max" : "1", - "base" : { - "path" : "Observation.component.code", - "min" : 1, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - }, - "mapping" : [{ - "identity" : "w5", - "map" : "FiveWs.what[x]" - }, - { - "identity" : "sct-concept", - "map" : "< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|" - }, - { - "identity" : "v2", - "map" : "OBX-3" - }, - { - "identity" : "rim", - "map" : "code" - }] - }, - { - "id" : "Observation.component.value[x]", - "path" : "Observation.component.value[x]", - "short" : "Vital Sign Value recorded with UCUM", - "definition" : "Vital Sign Value recorded with UCUM.", - "comment" : "Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- For additional guidance, see the [Notes section](observation.html#notes) below.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.component.value[x]", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "Quantity" - }, - { - "code" : "CodeableConcept" - }, - { - "code" : "string" - }, - { - "code" : "boolean" - }, - { - "code" : "integer" - }, - { - "code" : "Range" - }, - { - "code" : "Ratio" - }, - { - "code" : "SampledData" - }, - { - "code" : "time" - }, - { - "code" : "dateTime" - }, - { - "code" : "Period" - }, - { - "code" : "Attachment" - }], - "condition" : ["vs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for recording Vital Signs." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSignsUnits" - }], - "strength" : "required", - "description" : "Commonly encountered UCUM units for recording Vital Signs.", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-vitals-common" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "363714003 |Interprets| < 441742003 |Evaluation finding|" - }, - { - "identity" : "v2", - "map" : "OBX.2, OBX.5, OBX.6" - }, - { - "identity" : "rim", - "map" : "value" - }, - { - "identity" : "sct-attr", - "map" : "363714003 |Interprets|" - }] - }, - { - "id" : "Observation.component.dataAbsentReason", - "path" : "Observation.component.dataAbsentReason", - "short" : "Why the component result is missing", - "definition" : "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", - "comment" : "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.", - "requirements" : "For many results it is necessary to handle exceptional values in measurements.", - "min" : 0, - "max" : "1", - "base" : { - "path" : "Observation.component.dataAbsentReason", - "min" : 0, - "max" : "1" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["obs-6", - "vs-3"], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : true, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationValueAbsentReason" - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", - "valueBoolean" : true - }], - "strength" : "extensible", - "description" : "Codes specifying why the result (`Observation.value[x]`) is missing.", - "valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason" - }, - "mapping" : [{ - "identity" : "v2", - "map" : "N/A" - }, - { - "identity" : "rim", - "map" : "value.nullFlavor" - }] - }, - { - "id" : "Observation.component.interpretation", - "path" : "Observation.component.interpretation", - "short" : "High, low, normal, etc.", - "definition" : "A categorical assessment of an observation value. For example, high, low, normal.", - "comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", - "requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", - "alias" : ["Abnormal Flag"], - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component.interpretation", - "min" : 0, - "max" : "*" - }, - "type" : [{ - "code" : "CodeableConcept" - }], - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "ObservationInterpretation" - }], - "strength" : "extensible", - "description" : "Codes identifying interpretations of observations.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation" - }, - "mapping" : [{ - "identity" : "sct-concept", - "map" : "< 260245000 |Findings values|" - }, - { - "identity" : "v2", - "map" : "OBX-8" - }, - { - "identity" : "rim", - "map" : "interpretationCode" - }, - { - "identity" : "sct-attr", - "map" : "363713009 |Has interpretation|" - }] - }, - { - "id" : "Observation.component.referenceRange", - "path" : "Observation.component.referenceRange", - "short" : "Provides guide for interpretation of component result", - "definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range.", - "comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", - "requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", - "min" : 0, - "max" : "*", - "base" : { - "path" : "Observation.component.referenceRange", - "min" : 0, - "max" : "*" - }, - "contentReference" : "http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange", - "constraint" : [{ - "key" : "ele-1", - "severity" : "error", - "human" : "All FHIR elements must have a @value or children", - "expression" : "hasValue() or (children().count() > id.count())", - "xpath" : "@value|f:*|h:div", - "source" : "http://hl7.org/fhir/StructureDefinition/Element" - }], - "mustSupport" : false, - "isModifier" : false, - "isSummary" : false, - "mapping" : [{ - "identity" : "v2", - "map" : "OBX.7" - }, - { - "identity" : "rim", - "map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" - }] - }] - }, - "differential" : { - "element" : [{ - "id" : "Observation", - "path" : "Observation", - "short" : "FHIR Vital Signs Profile", - "definition" : "The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient.", - "alias" : ["Vital Signs", - "Measurement", - "Results", - "Tests"], - "min" : 0, - "max" : "*", - "constraint" : [{ - "key" : "vs-2", - "severity" : "error", - "human" : "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", - "expression" : "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", - "xpath" : "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }] - }, - { - "id" : "Observation.status", - "path" : "Observation.status", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "mustSupport" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "Status" - }], - "strength" : "required", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-status" - } - }, - { - "id" : "Observation.category", - "path" : "Observation.category", - "slicing" : { - "discriminator" : [{ - "type" : "value", - "path" : "coding.code" - }, - { - "type" : "value", - "path" : "coding.system" - }], - "ordered" : false, - "rules" : "open" - }, - "min" : 1, - "max" : "*", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : true - }, - { - "id" : "Observation.category:VSCat", - "path" : "Observation.category", - "sliceName" : "VSCat", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : true - }, - { - "id" : "Observation.category:VSCat.coding", - "path" : "Observation.category.coding", - "min" : 1, - "max" : "*", - "type" : [{ - "code" : "Coding" - }], - "mustSupport" : true - }, - { - "id" : "Observation.category:VSCat.coding.system", - "path" : "Observation.category.coding.system", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "uri" - }], - "fixedUri" : "http://terminology.hl7.org/CodeSystem/observation-category", - "mustSupport" : true - }, - { - "id" : "Observation.category:VSCat.coding.code", - "path" : "Observation.category.coding.code", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "code" - }], - "fixedCode" : "vital-signs", - "mustSupport" : true - }, - { - "id" : "Observation.code", - "path" : "Observation.code", - "short" : "Coded Responses from C-CDA Vital Sign Results", - "definition" : "Coded Responses from C-CDA Vital Sign Results.", - "requirements" : "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - } - }, - { - "id" : "Observation.subject", - "path" : "Observation.subject", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"] - }], - "mustSupport" : true - }, - { - "id" : "Observation.effective[x]", - "path" : "Observation.effective[x]", - "short" : "Often just a dateTime for Vital Signs", - "definition" : "Often just a dateTime for Vital Signs.", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "dateTime" - }, - { - "code" : "Period" - }], - "condition" : ["vs-1"], - "constraint" : [{ - "key" : "vs-1", - "severity" : "error", - "human" : "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", - "expression" : "($this as dateTime).toString().length() >= 8", - "xpath" : "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true - }, - { - "id" : "Observation.value[x]", - "path" : "Observation.value[x]", - "short" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "definition" : "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "condition" : ["vs-2"], - "mustSupport" : true - }, - { - "id" : "Observation.dataAbsentReason", - "path" : "Observation.dataAbsentReason", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["vs-2"], - "mustSupport" : true - }, - { - "id" : "Observation.hasMember", - "path" : "Observation.hasMember", - "short" : "Used when reporting vital signs panel components", - "definition" : "Used when reporting vital signs panel components.", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }] - }, - { - "id" : "Observation.derivedFrom", - "path" : "Observation.derivedFrom", - "type" : [{ - "code" : "Reference", - "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference", - "http://hl7.org/fhir/StructureDefinition/ImagingStudy", - "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", - "http://hl7.org/fhir/StructureDefinition/MolecularSequence", - "http://hl7.org/fhir/StructureDefinition/vitalsigns"] - }] - }, - { - "id" : "Observation.component", - "path" : "Observation.component", - "short" : "Used when reporting systolic and diastolic blood pressure.", - "definition" : "Used when reporting systolic and diastolic blood pressure.", - "constraint" : [{ - "key" : "vs-3", - "severity" : "error", - "human" : "If there is no a value a data absent reason must be present", - "expression" : "value.exists() or dataAbsentReason.exists()", - "xpath" : "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", - "source" : "http://hl7.org/fhir/StructureDefinition/vitalsigns" - }], - "mustSupport" : true - }, - { - "id" : "Observation.component.code", - "path" : "Observation.component.code", - "min" : 1, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "mustSupport" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "This identifies the vital sign result type." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSigns" - }], - "strength" : "extensible", - "description" : "This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.", - "valueSet" : "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" - } - }, - { - "id" : "Observation.component.value[x]", - "path" : "Observation.component.value[x]", - "short" : "Vital Sign Value recorded with UCUM", - "definition" : "Vital Sign Value recorded with UCUM.", - "requirements" : "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", - "min" : 0, - "max" : "1", - "condition" : ["vs-3"], - "mustSupport" : true, - "binding" : { - "extension" : [{ - "url" : "http://hl7.org/fhir/build/StructureDefinition/definition", - "valueString" : "Common UCUM units for recording Vital Signs." - }, - { - "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", - "valueString" : "VitalSignsUnits" - }], - "strength" : "required", - "description" : "Commonly encountered UCUM units for recording Vital Signs.", - "valueSet" : "http://hl7.org/fhir/ValueSet/ucum-vitals-common" - } - }, - { - "id" : "Observation.component.dataAbsentReason", - "path" : "Observation.component.dataAbsentReason", - "min" : 0, - "max" : "1", - "type" : [{ - "code" : "CodeableConcept" - }], - "condition" : ["vs-3"], - "mustSupport" : true - }] - } -} \ No newline at end of file +{"resourceType":"StructureDefinition","id":"vitalsigns","text":{"status":"generated","div":"
to do
"},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-summary","valueMarkdown":"\"#### Complete Summary of the Mandatory Requirements\n\n1. One status in `Observation.status` which has a [required](terminologies.html#extensible) binding to:\n - [ObservationStatus] value set.\n1. A category in `Observation.category` which must have:\n - a fixed `Observation.category.coding.system`=\"http://terminology.hl7.org/CodeSystem/observation-category\"\n - a fixed `Observation.category.coding.code`= \"vital-signs\"\n\n1. A code in `Observation.code`\n - a fixed `Observation.code.coding.system`= \"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible](terminologies.html#extensible) binding to:\n - [Vital Signs] value set.\n \n1. One patient in `Observation.subject`\n1. A date and time in `effectiveDateTime` or `effectivePeriod`\n1. Either one `Observation.value[x]` or, if there is no value, one code in `Observation.DataAbsentReason`\n - if a vital sign measure then:\n - One numeric value in Observation.valueQuantity.value\n - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\n - a UCUM unit code in Observation.valueQuantity.code which has a required binding to the [Vital Signs Units] value set.\n - Observation.DataAbsentReason is bound to [Observation Value\n Absent Reason] value set.\n\n1. When using a panel code to group component observations (Note: See\n the comments regarding blood pressure in the table above), one or\n more `Observation.component.code` each of which must have:\n - a fixed\n `Observation.component.code.coding.system` =\"\"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible] binding to:\n - [Vital Signs Units] value set.\n\n1. Either one `Observation.component.valueQuantity` or, if there is\n no value, one code in `Observation.component.DataAbsentReason`\n - Observation.component.DataAbsentReason is bound to [Observation\n Value Absent Reason] value set.\n\n1. When using a panel code to group observations, one or more reference\n to Vitals Signs Observations in `Observation.related.target`\n - a fixed `Observation.related.type`= \"has-member\"\"\n\n [Vital Signs]: valueset-observation-vitalsignresult.html\n [Vital Signs Units]: valueset-ucum-vitals-common.html\n [extensible]: terminologies.html#extensible\n [ObservationStatus]: valueset-observation-status.html\n [Observation Value Absent Reason]: valueset-data-absent-reason.html\n[required]: terminologies.html#required\""},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"oo"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/tools/StructureDefinition/profile-summary","valueString":"\"#### Complete Summary of the Mandatory Requirements\n\n1. One status in `Observation.status` which has a [required](terminologies.html#extensible) binding to:\n - [ObservationStatus] value set.\n1. A category in `Observation.category` which must have:\n - a fixed `Observation.category.coding.system`=\"http://terminology.hl7.org/CodeSystem/observation-category\"\n - a fixed `Observation.category.coding.code`= \"vital-signs\"\n\n1. A code in `Observation.code`\n - a fixed `Observation.code.coding.system`= \"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible](terminologies.html#extensible) binding to:\n - [Vital Signs] value set.\n \n1. One patient in `Observation.subject`\n1. A date and time in `effectiveDateTime` or `effectivePeriod`\n1. Either one `Observation.value[x]` or, if there is no value, one code in `Observation.DataAbsentReason`\n - if a vital sign measure then:\n - One numeric value in Observation.valueQuantity.value\n - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\n - a UCUM unit code in Observation.valueQuantity.code which has a required binding to the [Vital Signs Units] value set.\n - Observation.DataAbsentReason is bound to [Observation Value\n Absent Reason] value set.\n\n1. When using a panel code to group component observations (Note: See\n the comments regarding blood pressure in the table above), one or\n more `Observation.component.code` each of which must have:\n - a fixed\n `Observation.component.code.coding.system` =\"\"http://loinc.org\"\"\n - a LOINC code in `Observation.code.coding.code` which has an [extensible] binding to:\n - [Vital Signs Units] value set.\n\n1. Either one `Observation.component.valueQuantity` or, if there is\n no value, one code in `Observation.component.DataAbsentReason`\n - Observation.component.DataAbsentReason is bound to [Observation\n Value Absent Reason] value set.\n\n1. When using a panel code to group observations, one or more reference\n to Vitals Signs Observations in `Observation.related.target`\n - a fixed `Observation.related.type`= \"has-member\"\"\n\n [Vital Signs]: valueset-observation-vitalsignresult.html\n [Vital Signs Units]: valueset-ucum-vitals-common.html\n [extensible]: terminologies.html#extensible\n [ObservationStatus]: valueset-observation-status.html\n [Observation Value Absent Reason]: valueset-data-absent-reason.html\n[required]: terminologies.html#required\""}],"url":"http://hl7.org/fhir/StructureDefinition/vitalsigns","identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:2.16.840.1.113883.4.642.5.1461"}],"version":"5.0.0","name":"Observationvitalsigns","title":"Vital Signs Profile","status":"draft","experimental":false,"date":"2016-03-25","publisher":"Health Level Seven International (Orders and Observations Workgroup)","contact":[{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/orders/index.cfm Orders and Observations"}]}],"description":"FHIR Vital Signs Profile","fhirVersion":"5.0.0","mapping":[{"identity":"workflow","uri":"http://hl7.org/fhir/workflow","name":"Workflow Pattern"},{"identity":"sct-concept","uri":"http://snomed.info/conceptdomain","name":"SNOMED CT Concept Domain Binding"},{"identity":"v2","uri":"http://hl7.org/v2","name":"HL7 V2 Mapping"},{"identity":"rim","uri":"http://hl7.org/v3","name":"RIM Mapping"},{"identity":"w5","uri":"http://hl7.org/fhir/fivews","name":"FiveWs Pattern Mapping"},{"identity":"sct-attr","uri":"http://snomed.org/attributebinding","name":"SNOMED CT Attribute Binding"}],"kind":"resource","abstract":false,"type":"Observation","baseDefinition":"http://hl7.org/fhir/StructureDefinition/Observation","derivation":"constraint","snapshot":{"element":[{"id":"Observation","path":"Observation","short":"FHIR Vital Signs Profile","definition":"The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient.","comment":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.","alias":["Vital Signs","Measurement","Results","Tests"],"min":0,"max":"*","base":{"path":"Observation","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()","source":"http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()","source":"http://hl7.org/fhir/StructureDefinition/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()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"dom-5","severity":"error","human":"If a resource is contained in another resource, it SHALL NOT have a security label","expression":"contained.meta.security.empty()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"key":"dom-6","severity":"warning","human":"A resource should have narrative for robust management","expression":"text.`div`.exists()","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"key":"obs-6","severity":"error","human":"dataAbsentReason SHALL only be present if Observation.value[x] is not present","expression":"dataAbsentReason.empty() or value.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-7","severity":"error","human":"If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).","expression":"value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"obs-8","severity":"error","human":"bodyStructure SHALL only be present if Observation.bodySite is not present","expression":"bodySite.exists() implies bodyStructure.empty()","source":"http://hl7.org/fhir/StructureDefinition/Observation"},{"key":"vs-2","severity":"error","human":"If there is no component or hasMember element then either a value[x] or a data absent reason must be present.","expression":"(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Observation[classCode=OBS, moodCode=EVN]"},{"identity":"workflow","map":"Event"},{"identity":"w5","map":"clinical.diagnostics"},{"identity":"sct-concept","map":"< 363787002 |Observable entity|"},{"identity":"v2","map":"OBX"}]},{"id":"Observation.id","path":"Observation.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":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","min":0,"max":"1","base":{"path":"Resource.id","min":0,"max":"1"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.meta","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true},{"id":"Observation.implicitRules","path":"Observation.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","min":0,"max":"1","base":{"path":"Resource.implicitRules","min":0,"max":"1"},"type":[{"code":"uri"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true},{"id":"Observation.language","path":"Observation.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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","description":"IETF language tag for a human language","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|5.0.0","additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}]}},{"id":"Observation.text","path":"Observation.text","short":"Text summary of the resource, for human interpretation","definition":"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.","comment":"Contained resources do not have a 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 information 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-6"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}]},{"id":"Observation.contained","path":"Observation.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","alias":["inline resources","anonymous resources","contained resources"],"min":0,"max":"*","base":{"path":"DomainResource.contained","min":0,"max":"*"},"type":[{"code":"Resource"}],"condition":["dom-2","dom-4","dom-3","dom-5"],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.extension","path":"Observation.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.modifierExtension","path":"Observation.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content"],"min":0,"max":"*","base":{"path":"DomainResource.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"mustSupport":false,"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.identifier","path":"Observation.identifier","short":"Business Identifier for observation","definition":"A unique identifier assigned to this observation.","requirements":"Allows observations to be distinguished and referenced.","min":0,"max":"*","base":{"path":"Observation.identifier","min":0,"max":"*"},"type":[{"code":"Identifier"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.identifier"},{"identity":"w5","map":"FiveWs.identifier"},{"identity":"v2","map":"OBX-21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 3) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."},{"identity":"rim","map":"id"}]},{"id":"Observation.instantiates[x]","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.instantiates[x]","short":"Instantiates FHIR ObservationDefinition","definition":"The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.","comment":"ObservationDefinition can be referenced by its canonical url using instantiatesCanonical, or by a name or an identifier using the appropriate sub-elements of instantiatesReference.","min":0,"max":"1","base":{"path":"Observation.instantiates[x]","min":0,"max":"1"},"type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.instantiatesCanonical"},{"identity":"rim","map":".outboundRelationship[typeCode=DEFN].target"}]},{"id":"Observation.basedOn","path":"Observation.basedOn","short":"Fulfills plan, proposal or order","definition":"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.","requirements":"Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","alias":["Fulfills"],"min":0,"max":"*","base":{"path":"Observation.basedOn","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/CarePlan","http://hl7.org/fhir/StructureDefinition/DeviceRequest","http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation","http://hl7.org/fhir/StructureDefinition/MedicationRequest","http://hl7.org/fhir/StructureDefinition/NutritionOrder","http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.basedOn"},{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.triggeredBy","short":"Triggering observation(s)","definition":"Identifies the observation(s) that triggered the performance of this observation.","min":0,"max":"*","base":{"path":"Observation.triggeredBy","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"ORC"},{"identity":"rim","map":".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]},{"id":"Observation.triggeredBy.id","path":"Observation.triggeredBy.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.extension","path":"Observation.triggeredBy.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.triggeredBy.modifierExtension","path":"Observation.triggeredBy.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.triggeredBy.observation","path":"Observation.triggeredBy.observation","short":"Triggering observation","definition":"Reference to the triggering observation.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.observation","min":1,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Observation"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.triggeredBy.type","path":"Observation.triggeredBy.type","short":"reflex | repeat | re-run","definition":"The type of trigger.\nReflex | Repeat | Re-run.","min":1,"max":"1","base":{"path":"Observation.triggeredBy.type","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"TriggeredByType"}],"strength":"required","description":"The type of TriggeredBy Observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-triggeredbytype|5.0.0"},"mapping":[{"identity":"rim","map":"code"}]},{"id":"Observation.triggeredBy.reason","path":"Observation.triggeredBy.reason","short":"Reason that the observation was triggered","definition":"Provides the reason why this observation was performed as a result of the observation(s) referenced.","min":0,"max":"1","base":{"path":"Observation.triggeredBy.reason","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"annotation"}]},{"id":"Observation.partOf","path":"Observation.partOf","short":"Part of referenced event","definition":"A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.","comment":"To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.","alias":["Container"],"min":0,"max":"*","base":{"path":"Observation.partOf","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MedicationAdministration","http://hl7.org/fhir/StructureDefinition/MedicationDispense","http://hl7.org/fhir/StructureDefinition/MedicationStatement","http://hl7.org/fhir/StructureDefinition/Procedure","http://hl7.org/fhir/StructureDefinition/Immunization","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/GenomicStudy"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.partOf"},{"identity":"v2","map":"Varies by domain"},{"identity":"rim","map":".outboundRelationship[typeCode=FLFS].target"}]},{"id":"Observation.status","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint","valueString":"default: final"}],"path":"Observation.status","short":"registered | preliminary | final | amended +","definition":"The status of the result value.","comment":"This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","requirements":"Need to track the status of individual results. Some results are finalized before the whole report is finalized.","min":1,"max":"1","base":{"path":"Observation.status","min":1,"max":"1"},"type":[{"code":"code"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":true,"isModifierReason":"This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid","isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Status"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/observation-status"},"mapping":[{"identity":"workflow","map":"Event.status"},{"identity":"w5","map":"FiveWs.status"},{"identity":"sct-concept","map":"< 445584004 |Report by finality status|"},{"identity":"v2","map":"OBX-11"},{"identity":"rim","map":"status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}]},{"id":"Observation.category","path":"Observation.category","slicing":{"discriminator":[{"type":"value","path":"coding.code"},{"type":"value","path":"coding.system"}],"ordered":false,"rules":"open"},"short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":1,"max":"*","base":{"path":"Observation.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.category:VSCat","path":"Observation.category","sliceName":"VSCat","short":"Classification of type of observation","definition":"A code that classifies the general type of observation being made.","comment":"In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.","requirements":"Used for filtering what observations are retrieved and displayed.","min":1,"max":"1","base":{"path":"Observation.category","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationCategory"}],"strength":"preferred","description":"Codes for high level observation categories.","valueSet":"http://hl7.org/fhir/ValueSet/observation-category"},"mapping":[{"identity":"w5","map":"FiveWs.class"},{"identity":"rim","map":".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]},{"id":"Observation.category:VSCat.id","path":"Observation.category.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.extension","path":"Observation.category.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding","path":"Observation.category.coding","short":"Code defined by a terminology system","definition":"A reference to a code defined by a terminology system.","comment":"Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.","requirements":"Allows for alternative encodings within a code system, and translations to other code systems.","min":1,"max":"*","base":{"path":"CodeableConcept.coding","min":0,"max":"*"},"type":[{"code":"Coding"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1-8, C*E.10-22"},{"identity":"rim","map":"union(., ./translation)"},{"identity":"orim","map":"fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]},{"id":"Observation.category:VSCat.coding.id","path":"Observation.category.coding.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding.extension","path":"Observation.category.coding.extension","slicing":{"discriminator":[{"type":"value","path":"url"}],"description":"Extensions are always sliced by (at least) url","rules":"open"},"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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.category:VSCat.coding.system","path":"Observation.category.coding.system","short":"Identity of the terminology system","definition":"The identification of the code system that defines the meaning of the symbol in the code.","comment":"The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.","requirements":"Need to be unambiguous about the source of the definition of the symbol.","min":1,"max":"1","base":{"path":"Coding.system","min":0,"max":"1"},"type":[{"code":"uri"}],"fixedUri":"http://terminology.hl7.org/CodeSystem/observation-category","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.3"},{"identity":"rim","map":"./codeSystem"},{"identity":"orim","map":"fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]},{"id":"Observation.category:VSCat.coding.version","path":"Observation.category.coding.version","short":"Version of the system - if relevant","definition":"The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.","comment":"Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.","min":0,"max":"1","base":{"path":"Coding.version","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.7"},{"identity":"rim","map":"./codeSystemVersion"},{"identity":"orim","map":"fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]},{"id":"Observation.category:VSCat.coding.code","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/no-binding","valueBoolean":true}],"path":"Observation.category.coding.code","short":"Symbol in syntax defined by the system","definition":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).","requirements":"Need to refer to a particular code in the system.","min":1,"max":"1","base":{"path":"Coding.code","min":0,"max":"1"},"type":[{"code":"code"}],"fixedCode":"vital-signs","condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.1"},{"identity":"rim","map":"./code"},{"identity":"orim","map":"fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]},{"id":"Observation.category:VSCat.coding.display","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.category.coding.display","short":"Representation defined by the system","definition":"A representation of the meaning of the code in the system, following the rules of the system.","requirements":"Need to be able to carry a human-readable meaning of the code for readers that do not know the system.","min":0,"max":"1","base":{"path":"Coding.display","min":0,"max":"1"},"type":[{"code":"string"}],"condition":["cod-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.2 - but note this is not well followed"},{"identity":"rim","map":"CV.displayName"},{"identity":"orim","map":"fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]},{"id":"Observation.category:VSCat.coding.userSelected","path":"Observation.category.coding.userSelected","short":"If this coding was chosen directly by the user","definition":"Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).","comment":"Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.","requirements":"This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.","min":0,"max":"1","base":{"path":"Coding.userSelected","min":0,"max":"1"},"type":[{"code":"boolean"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Sometimes implied by being first"},{"identity":"rim","map":"CD.codingRationale"},{"identity":"orim","map":"fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"}]},{"id":"Observation.category:VSCat.text","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable","valueBoolean":true}],"path":"Observation.category.text","short":"Plain text representation of the concept","definition":"A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.","comment":"Very often the text is the same as a displayName of one of the codings.","requirements":"The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.","min":0,"max":"1","base":{"path":"CodeableConcept.text","min":0,"max":"1"},"type":[{"code":"string"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"C*E.9. But note many systems use C*E.2 for this"},{"identity":"rim","map":"./originalText[mediaType/code=\"text/plain\"]/data"},{"identity":"orim","map":"fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"}]},{"id":"Observation.code","path":"Observation.code","short":"Coded Responses from C-CDA Vital Sign Results","definition":"Coded Responses from C-CDA Vital Sign Results.","comment":"*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).","alias":["Name"],"min":1,"max":"1","base":{"path":"Observation.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"},{"identity":"sct-attr","map":"116680003 |Is a|"}]},{"id":"Observation.subject","path":"Observation.subject","short":"Who and/or what the observation is about","definition":"The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what 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.","comment":"One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. The subject of an Observation may in some cases be a procedure. This supports the regulatory inspection use case where observations are captured during inspections of a procedure that is being performed (independent of any particular patient or whether patient related at all).","requirements":"Observations have no value if you don't know who or what they're about.","min":1,"max":"1","base":{"path":"Observation.subject","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.subject"},{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"PID-3"},{"identity":"rim","map":"participation[typeCode=RTGT]"}]},{"id":"Observation.focus","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.focus","short":"What the observation is about, when it is not about the subject of record","definition":"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.","comment":"Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [http://hl7.org/fhir/StructureDefinition/observation-focusCode](http://hl7.org/fhir/extensions/StructureDefinition-observation-focusCode.html).","min":0,"max":"*","base":{"path":"Observation.focus","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"participation[typeCode=SBJ]"}]},{"id":"Observation.encounter","path":"Observation.encounter","short":"Healthcare event during which this observation is made","definition":"The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.","comment":"This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).","requirements":"For some observations it may be important to know the link between an observation and a particular encounter.","alias":["Context"],"min":0,"max":"1","base":{"path":"Observation.encounter","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Encounter"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.encounter"},{"identity":"w5","map":"FiveWs.context"},{"identity":"v2","map":"PV1"},{"identity":"rim","map":"inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]},{"id":"Observation.effective[x]","path":"Observation.effective[x]","short":"Often just a dateTime for Vital Signs","definition":"Often just a dateTime for Vital Signs.","comment":"At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","requirements":"Knowing when an observation was deemed true is important to its relevance as well as determining trends.","alias":["Occurrence"],"min":1,"max":"1","base":{"path":"Observation.effective[x]","min":0,"max":"1"},"type":[{"code":"dateTime"},{"code":"Period"}],"condition":["vs-1"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"vs-1","severity":"error","human":"if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day","expression":"($this as dateTime).toString().length() >= 8","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.occurrence[x]"},{"identity":"w5","map":"FiveWs.done[x]"},{"identity":"v2","map":"OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"},{"identity":"rim","map":"effectiveTime"}]},{"id":"Observation.issued","path":"Observation.issued","short":"Date/Time this version was made available","definition":"The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","comment":"For Observations that don't require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.","min":0,"max":"1","base":{"path":"Observation.issued","min":0,"max":"1"},"type":[{"code":"instant"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.recorded"},{"identity":"v2","map":"OBR-22 (or MSH-7), or perhaps OBX-19 (depends on who observation made)"},{"identity":"rim","map":"participation[typeCode=AUT].time"}]},{"id":"Observation.performer","path":"Observation.performer","short":"Who is responsible for the observation","definition":"Who was responsible for asserting the observed value as \"true\".","requirements":"May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","min":0,"max":"*","base":{"path":"Observation.performer","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/CareTeam","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.performer.actor"},{"identity":"w5","map":"FiveWs.actor"},{"identity":"v2","map":"OBX-15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"},{"identity":"rim","map":"participation[typeCode=PRF]"}]},{"id":"Observation.value[x]","path":"Observation.value[x]","short":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","definition":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","comment":"- An observation may have:\n 1. a single value here\n 1. both a value and a set of related or component values\n 1. only a set of related or component values.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["obs-7","obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"< 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.dataAbsentReason","path":"Observation.dataAbsentReason","short":"Why the result is missing","definition":"Provides a reason why the expected value in the element Observation.value[x] is missing.","comment":"Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-6","vs-2"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.interpretation","path":"Observation.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.note","path":"Observation.note","short":"Comments about the observation","definition":"Comments about the observation or the results.","comment":"May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.","requirements":"Need to be able to provide free text additional information.","min":0,"max":"*","base":{"path":"Observation.note","min":0,"max":"*"},"type":[{"code":"Annotation"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"NTE-3 (partner NTE to OBX, or sometimes another (child?) OBX)"},{"identity":"rim","map":"subjectOf.observationEvent[code=\"annotation\"].value"}]},{"id":"Observation.bodySite","path":"Observation.bodySite","short":"Observed body part","definition":"Indicates the site on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodySite","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Codes describing anatomical locations. May include laterality."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"BodySite"}],"strength":"example","description":"SNOMED CT Body site concepts","valueSet":"http://hl7.org/fhir/ValueSet/body-site"},"mapping":[{"identity":"sct-concept","map":"< 123037004 |Body structure|"},{"identity":"v2","map":"OBX-20"},{"identity":"rim","map":"targetSiteCode"},{"identity":"sct-attr","map":"718497002 |Inherent location|"}]},{"id":"Observation.bodyStructure","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.bodyStructure","short":"Observed body structure","definition":"Indicates the body structure on the subject's body where the observation was made (i.e. the target site).","comment":"Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.","min":0,"max":"1","base":{"path":"Observation.bodyStructure","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/BodyStructure"]}],"condition":["obs-8"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"targetSiteCode"}]},{"id":"Observation.method","path":"Observation.method","short":"How it was done","definition":"Indicates the mechanism used to perform the observation.","comment":"Only used if not implicit in code for Observation.code.","requirements":"In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","min":0,"max":"1","base":{"path":"Observation.method","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationMethod"}],"strength":"example","description":"Methods for simple observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-methods"},"mapping":[{"identity":"v2","map":"OBX-17"},{"identity":"rim","map":"methodCode"}]},{"id":"Observation.specimen","path":"Observation.specimen","short":"Specimen used for this observation","definition":"The specimen that was used when this observation was made.","comment":"Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).","min":0,"max":"1","base":{"path":"Observation.specimen","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Specimen","http://hl7.org/fhir/StructureDefinition/Group"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-9","severity":"error","human":"If Observation.specimen is a reference to Group, the group can only have specimens","expression":"(reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 123038009 |Specimen|"},{"identity":"v2","map":"SPM segment"},{"identity":"rim","map":"participation[typeCode=SPC].specimen"},{"identity":"sct-attr","map":"704319004 |Inherent in|"}]},{"id":"Observation.device","path":"Observation.device","short":"A reference to the device that generates the measurements or the device settings for the device","definition":"A reference to the device that generates the measurements or the device settings for the device.","comment":"Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.","min":0,"max":"1","base":{"path":"Observation.device","min":0,"max":"1"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"sct-concept","map":"< 49062001 |Device|"},{"identity":"v2","map":"OBX-17 / PRT -10"},{"identity":"rim","map":"participation[typeCode=DEV]"},{"identity":"sct-attr","map":"424226004 |Using device|"}]},{"id":"Observation.referenceRange","path":"Observation.referenceRange","short":"Provides guide for interpretation","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.referenceRange","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"obs-3","severity":"error","human":"Must have at least a low or a high or text","expression":"low.exists() or high.exists() or text.exists()","source":"http://hl7.org/fhir/StructureDefinition/Observation"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]},{"id":"Observation.referenceRange.id","path":"Observation.referenceRange.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.extension","path":"Observation.referenceRange.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.referenceRange.modifierExtension","path":"Observation.referenceRange.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.referenceRange.low","path":"Observation.referenceRange.low","short":"Low Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.low","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.low"}]},{"id":"Observation.referenceRange.high","path":"Observation.referenceRange.high","short":"High Range, if relevant","definition":"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).","min":0,"max":"1","base":{"path":"Observation.referenceRange.high","min":0,"max":"1"},"type":[{"code":"Quantity","profile":["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.high"}]},{"id":"Observation.referenceRange.normalValue","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.normalValue","short":"Normal value, if relevant","definition":"The value of the normal value of the reference range.","min":0,"max":"1","base":{"path":"Observation.referenceRange.normalValue","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationReferenceRangeNormalValue"}],"strength":"extensible","description":"Codes identifying the normal value of the observation.","valueSet":"http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue"},"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:IVL_PQ.normal"}]},{"id":"Observation.referenceRange.type","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"}],"path":"Observation.referenceRange.type","short":"Reference range qualifier","definition":"Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.","requirements":"Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.","min":0,"max":"1","base":{"path":"Observation.referenceRange.type","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeMeaning"}],"strength":"preferred","description":"Code for the meaning of a reference range.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-meaning"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.appliesTo","path":"Observation.referenceRange.appliesTo","short":"Reference range population","definition":"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.","comment":"This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.","requirements":"Need to be able to identify the target population for proper interpretation.","min":0,"max":"*","base":{"path":"Observation.referenceRange.appliesTo","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationRangeType"}],"strength":"example","description":"Codes identifying the population the reference range applies to.","valueSet":"http://hl7.org/fhir/ValueSet/referencerange-appliesto"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"},{"identity":"v2","map":"OBX-10"},{"identity":"rim","map":"interpretationCode"}]},{"id":"Observation.referenceRange.age","path":"Observation.referenceRange.age","short":"Applicable age range, if relevant","definition":"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.","requirements":"Some analytes vary greatly over age.","min":0,"max":"1","base":{"path":"Observation.referenceRange.age","min":0,"max":"1"},"type":[{"code":"Range"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}]},{"id":"Observation.referenceRange.text","path":"Observation.referenceRange.text","short":"Text based reference range in an observation","definition":"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\".","min":0,"max":"1","base":{"path":"Observation.referenceRange.text","min":0,"max":"1"},"type":[{"code":"markdown"}],"condition":["obs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"value:ST"}]},{"id":"Observation.hasMember","path":"Observation.hasMember","short":"Used when reporting vital signs panel components","definition":"Used when reporting vital signs panel components.","comment":"When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.","min":0,"max":"*","base":{"path":"Observation.hasMember","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":"outBoundRelationship"}]},{"id":"Observation.derivedFrom","path":"Observation.derivedFrom","short":"Related resource from which the observation is made","definition":"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.","comment":"All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.","min":0,"max":"*","base":{"path":"Observation.derivedFrom","min":0,"max":"*"},"type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"Relationships established by OBX-4 usage"},{"identity":"rim","map":".targetObservation"}]},{"id":"Observation.component","path":"Observation.component","short":"Used when reporting systolic and diastolic blood pressure.","definition":"Used when reporting systolic and diastolic blood pressure.","comment":"For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.","requirements":"Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.","min":0,"max":"*","base":{"path":"Observation.component","min":0,"max":"*"},"type":[{"code":"BackboneElement"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"vs-3","severity":"error","human":"If there is no a value a data absent reason must be present","expression":"value.exists() or dataAbsentReason.exists()","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"containment by OBX-4?"},{"identity":"rim","map":"outBoundRelationship[typeCode=COMP]"}]},{"id":"Observation.component.id","path":"Observation.component.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","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":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}],"code":"http://hl7.org/fhirpath/System.String"}],"condition":["ele-1"],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.extension","path":"Observation.component.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}]},{"id":"Observation.component.modifierExtension","path":"Observation.component.modifierExtension","short":"Extensions that cannot be ignored even if unrecognized","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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","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.","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","alias":["extensions","user content","modifiers"],"min":0,"max":"*","base":{"path":"BackboneElement.modifierExtension","min":0,"max":"*"},"type":[{"code":"Extension"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"key":"ext-1","severity":"error","human":"Must have either extensions or value[x], not both","expression":"extension.exists() != value.exists()","source":"http://hl7.org/fhir/StructureDefinition/Extension"}],"isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}]},{"id":"Observation.component.code","path":"Observation.component.code","short":"Type of component observation (code / type)","definition":"Describes what was observed. Sometimes this is called the observation \"code\".","comment":"*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","requirements":"Knowing what kind of observation is being made is essential to understanding the observation.","min":1,"max":"1","base":{"path":"Observation.component.code","min":1,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["obs-7"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},"mapping":[{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"sct-concept","map":"< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"},{"identity":"v2","map":"OBX-3"},{"identity":"rim","map":"code"}]},{"id":"Observation.component.value[x]","path":"Observation.component.value[x]","slicing":{"discriminator":[{"type":"type","path":"$this"}],"ordered":false,"rules":"open"},"short":"Vital Sign Value","definition":"Vital Sign Value.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","base":{"path":"Observation.component.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"},{"code":"CodeableConcept"},{"code":"string"},{"code":"boolean"},{"code":"integer"},{"code":"Range"},{"code":"Ratio"},{"code":"SampledData"},{"code":"time"},{"code":"dateTime"},{"code":"Period"},{"code":"Attachment"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]}],"condition":["vs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.value[x]:valueQuantity","path":"Observation.component.value[x]","sliceName":"valueQuantity","short":"Vital Sign Value recorded with UCUM","definition":"Vital Sign Value recorded with UCUM.","comment":"Used when observation has a set of component observations:\n- An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). \n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- If a value is present, the datatype for this element should be determined by the `code`.\n- *CodeableConcept* with just a text would be used instead of a string if the field was usually coded, or if the type associated with the `code` defines a coded value.\n- *Attachment* is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using *DocumentReference* and referenced by `derivedFrom`.\n- The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. .\n- For additional guidance, see the [Notes section](observation.html#notes) below.","requirements":"An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","min":0,"max":"1","base":{"path":"Observation.component.value[x]","min":0,"max":"1"},"type":[{"code":"Quantity"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for recording Vital Signs."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSignsUnits"}],"strength":"required","description":"Commonly encountered UCUM units for recording Vital Signs.","valueSet":"http://hl7.org/fhir/ValueSet/ucum-vitals-common"},"mapping":[{"identity":"sct-concept","map":"363714003 |Interprets| < 441742003 |Evaluation finding|"},{"identity":"v2","map":"OBX-2, OBX-5, OBX-6"},{"identity":"rim","map":"value"},{"identity":"sct-attr","map":"363714003 |Interprets|"}]},{"id":"Observation.component.dataAbsentReason","path":"Observation.component.dataAbsentReason","short":"Why the component result is missing","definition":"Provides a reason why the expected value in the element Observation.component.value[x] is missing.","comment":"\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.","requirements":"For many results it is necessary to handle exceptional values in measurements.","min":0,"max":"1","base":{"path":"Observation.component.dataAbsentReason","min":0,"max":"1"},"type":[{"code":"CodeableConcept"}],"condition":["vs-3"],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":true,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationValueAbsentReason"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","description":"Codes specifying why the result (`Observation.value[x]`) is missing.","valueSet":"http://hl7.org/fhir/ValueSet/data-absent-reason"},"mapping":[{"identity":"v2","map":"N/A"},{"identity":"rim","map":"value.nullFlavor"}]},{"id":"Observation.component.interpretation","path":"Observation.component.interpretation","short":"High, low, normal, etc","definition":"A categorical assessment of an observation value. For example, high, low, normal.","comment":"Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.","requirements":"For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","alias":["Abnormal Flag"],"min":0,"max":"*","base":{"path":"Observation.component.interpretation","min":0,"max":"*"},"type":[{"code":"CodeableConcept"}],"constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ObservationInterpretation"}],"strength":"extensible","description":"Codes identifying interpretations of observations.","valueSet":"http://hl7.org/fhir/ValueSet/observation-interpretation"},"mapping":[{"identity":"sct-concept","map":"< 260245000 |Findings values|"},{"identity":"v2","map":"OBX-8"},{"identity":"rim","map":"interpretationCode"},{"identity":"sct-attr","map":"363713009 |Has interpretation|"}]},{"id":"Observation.component.referenceRange","path":"Observation.component.referenceRange","short":"Provides guide for interpretation of component result","definition":"Guidance on how to interpret the value by comparison to a normal or recommended range.","comment":"Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.","requirements":"Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.","min":0,"max":"*","base":{"path":"Observation.component.referenceRange","min":0,"max":"*"},"contentReference":"http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange","constraint":[{"key":"ele-1","severity":"error","human":"All FHIR elements must have a @value or children","expression":"hasValue() or (children().count() > id.count())","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"mustSupport":false,"isModifier":false,"isSummary":false,"mapping":[{"identity":"v2","map":"OBX-7"},{"identity":"rim","map":"outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]}]},"differential":{"element":[{"id":"Observation","path":"Observation","short":"FHIR Vital Signs Profile","definition":"The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient.","alias":["Vital Signs","Measurement","Results","Tests"],"min":0,"max":"*","constraint":[{"key":"vs-2","severity":"error","human":"If there is no component or hasMember element then either a value[x] or a data absent reason must be present.","expression":"(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}]},{"id":"Observation.status","path":"Observation.status","min":1,"max":"1","type":[{"code":"code"}],"mustSupport":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Status"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/observation-status"}},{"id":"Observation.category","path":"Observation.category","slicing":{"discriminator":[{"type":"value","path":"coding.code"},{"type":"value","path":"coding.system"}],"ordered":false,"rules":"open"},"min":1,"max":"*","type":[{"code":"CodeableConcept"}],"mustSupport":true},{"id":"Observation.category:VSCat","path":"Observation.category","sliceName":"VSCat","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":true},{"id":"Observation.category:VSCat.coding","path":"Observation.category.coding","min":1,"max":"*","type":[{"code":"Coding"}],"mustSupport":true},{"id":"Observation.category:VSCat.coding.system","path":"Observation.category.coding.system","min":1,"max":"1","type":[{"code":"uri"}],"fixedUri":"http://terminology.hl7.org/CodeSystem/observation-category","mustSupport":true},{"id":"Observation.category:VSCat.coding.code","path":"Observation.category.coding.code","min":1,"max":"1","type":[{"code":"code"}],"fixedCode":"vital-signs","mustSupport":true},{"id":"Observation.code","path":"Observation.code","short":"Coded Responses from C-CDA Vital Sign Results","definition":"Coded Responses from C-CDA Vital Sign Results.","requirements":"5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"}},{"id":"Observation.subject","path":"Observation.subject","min":1,"max":"1","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Patient"]}],"mustSupport":true},{"id":"Observation.effective[x]","path":"Observation.effective[x]","short":"Often just a dateTime for Vital Signs","definition":"Often just a dateTime for Vital Signs.","min":1,"max":"1","type":[{"code":"dateTime"},{"code":"Period"}],"condition":["vs-1"],"constraint":[{"key":"vs-1","severity":"error","human":"if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day","expression":"($this as dateTime).toString().length() >= 8","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true},{"id":"Observation.value[x]","path":"Observation.value[x]","short":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","definition":"Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","condition":["vs-2"],"mustSupport":true},{"id":"Observation.dataAbsentReason","path":"Observation.dataAbsentReason","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"condition":["vs-2"],"mustSupport":true},{"id":"Observation.hasMember","path":"Observation.hasMember","short":"Used when reporting vital signs panel components","definition":"Used when reporting vital signs panel components.","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}]},{"id":"Observation.derivedFrom","path":"Observation.derivedFrom","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/DocumentReference","http://hl7.org/fhir/StructureDefinition/ImagingStudy","http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse","http://hl7.org/fhir/StructureDefinition/MolecularSequence","http://hl7.org/fhir/StructureDefinition/vitalsigns"]}]},{"id":"Observation.component","path":"Observation.component","short":"Used when reporting systolic and diastolic blood pressure.","definition":"Used when reporting systolic and diastolic blood pressure.","constraint":[{"key":"vs-3","severity":"error","human":"If there is no a value a data absent reason must be present","expression":"value.exists() or dataAbsentReason.exists()","source":"http://hl7.org/fhir/StructureDefinition/vitalsigns"}],"mustSupport":true},{"id":"Observation.component.code","path":"Observation.component.code","min":1,"max":"1","type":[{"code":"CodeableConcept"}],"mustSupport":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"This identifies the vital sign result type."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSigns"}],"strength":"extensible","description":"This identifies the vital sign result type. Original source C-CDA R1.1 , HITSP Vital Sign Result Type.","valueSet":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"}},{"id":"Observation.component.value[x]","path":"Observation.component.value[x]","short":"Vital Sign Value","definition":"Vital Sign Value.","requirements":"9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).","min":0,"max":"1","condition":["vs-3"],"mustSupport":true},{"id":"Observation.component.valueQuantity","path":"Observation.component.valueQuantity","short":"Vital Sign Value recorded with UCUM","definition":"Vital Sign Value recorded with UCUM.","min":0,"max":"1","mustSupport":true,"binding":{"extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueString":"Common UCUM units for recording Vital Signs."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"VitalSignsUnits"}],"strength":"required","description":"Commonly encountered UCUM units for recording Vital Signs.","valueSet":"http://hl7.org/fhir/ValueSet/ucum-vitals-common"}},{"id":"Observation.component.dataAbsentReason","path":"Observation.component.dataAbsentReason","min":0,"max":"1","type":[{"code":"CodeableConcept"}],"condition":["vs-3"],"mustSupport":true}]}} \ No newline at end of file diff --git a/test/utils/Processing.test.ts b/test/utils/Processing.test.ts index 6f723a8c8..6b34c7fcb 100644 --- a/test/utils/Processing.test.ts +++ b/test/utils/Processing.test.ts @@ -620,7 +620,7 @@ describe('Processing', () => { testExtPackage( 'hl7.fhir.extensions.r5', 'hl7.fhir.r5.core', - 'current', + '5.0.0', 'hl7.fhir.r4.core', '4.0.1' )