FHIRPath
LOG IN
SIGN UP
If you
Log in
or
sign up
, you can edit this script yourself.
name
{ "resourceType": "Bundle", "id": "dataelements", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "type": "collection", "entry": [ { "fullUrl": "http://hl7.org/fhir/DataElement/date", "resource": { "resourceType": "DataElement", "id": "date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "date", "path": "date", "short": "Primitive Type date", "definition": "A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/date.id", "resource": { "resourceType": "DataElement", "id": "date.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/date.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "date.id", "path": "date.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/date.value", "resource": { "resourceType": "DataElement", "id": "date.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/date.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "date.value", "path": "date.value", "representation": [ "xmlAttr" ], "short": "Primitive value for date", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1]))?)?" } ], "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:gYear OR xsd:gYearMonth OR xsd:date" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:gYear OR xsd:gYearMonth OR xsd:date" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/dateTime", "resource": { "resourceType": "DataElement", "id": "dateTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/dateTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "dateTime", "path": "dateTime", "short": "Primitive Type dateTime", "definition": "A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/dateTime.id", "resource": { "resourceType": "DataElement", "id": "dateTime.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/dateTime.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "dateTime.id", "path": "dateTime.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/dateTime.value", "resource": { "resourceType": "DataElement", "id": "dateTime.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/dateTime.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "dateTime.value", "path": "dateTime.value", "representation": [ "xmlAttr" ], "short": "Primitive value for dateTime", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" } ], "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/string", "resource": { "resourceType": "DataElement", "id": "string", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/string", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "string", "path": "string", "short": "Primitive Type string", "definition": "A sequence of Unicode characters", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/string.id", "resource": { "resourceType": "DataElement", "id": "string.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/string.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/string.value", "resource": { "resourceType": "DataElement", "id": "string.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/string.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "string.value", "path": "string.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:string" } ] } } ], "maxLength": 1048576 } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/integer", "resource": { "resourceType": "DataElement", "id": "integer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/integer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "integer", "path": "integer", "short": "Primitive Type integer", "definition": "A whole number", "comment": "32 bit number; for values larger than this, use decimal", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/integer.id", "resource": { "resourceType": "DataElement", "id": "integer.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/integer.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "integer.id", "path": "integer.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/integer.value", "resource": { "resourceType": "DataElement", "id": "integer.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/integer.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "integer.value", "path": "integer.value", "representation": [ "xmlAttr" ], "short": "Primitive value for integer", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "-?([0]|([1-9][0-9]*))" } ], "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "number" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:int" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:int" } ] } } ], "minValueInteger": -2147483648, "maxValueInteger": 2147483647 } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/uri", "resource": { "resourceType": "DataElement", "id": "uri", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/uri", "status": "draft", "experimental": true, "stringency": "fully-specified", "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": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/uri.id", "resource": { "resourceType": "DataElement", "id": "uri.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/uri.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/uri.value", "resource": { "resourceType": "DataElement", "id": "uri.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/uri.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "uri.value", "path": "uri.value", "representation": [ "xmlAttr" ], "short": "Primitive value for uri", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:anyURI" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:string" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/instant", "resource": { "resourceType": "DataElement", "id": "instant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/instant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "instant", "path": "instant", "short": "Primitive Type instant", "definition": "An instant in time - known at least to the second", "comment": "Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/instant.id", "resource": { "resourceType": "DataElement", "id": "instant.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/instant.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "instant.id", "path": "instant.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/instant.value", "resource": { "resourceType": "DataElement", "id": "instant.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/instant.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "instant.value", "path": "instant.value", "representation": [ "xmlAttr" ], "short": "Primitive value for instant", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:dateTime" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:dateTime" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/boolean", "resource": { "resourceType": "DataElement", "id": "boolean", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/boolean", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "boolean", "path": "boolean", "short": "Primitive Type boolean", "definition": "Value of \"true\" or \"false\"", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/boolean.id", "resource": { "resourceType": "DataElement", "id": "boolean.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/boolean.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "boolean.id", "path": "boolean.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/boolean.value", "resource": { "resourceType": "DataElement", "id": "boolean.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/boolean.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "boolean.value", "path": "boolean.value", "representation": [ "xmlAttr" ], "short": "Primitive value for boolean", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "boolean" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:boolean" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:boolean" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/base64Binary", "resource": { "resourceType": "DataElement", "id": "base64Binary", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/base64Binary", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "base64Binary", "path": "base64Binary", "short": "Primitive Type base64Binary", "definition": "A stream of bytes", "comment": "A stream of bytes, base64 encoded", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/base64Binary.id", "resource": { "resourceType": "DataElement", "id": "base64Binary.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/base64Binary.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "base64Binary.id", "path": "base64Binary.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/base64Binary.value", "resource": { "resourceType": "DataElement", "id": "base64Binary.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/base64Binary.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "base64Binary.value", "path": "base64Binary.value", "representation": [ "xmlAttr" ], "short": "Primitive value for base64Binary", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:base64Binary" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:base64Binary" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/time", "resource": { "resourceType": "DataElement", "id": "time", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/time", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "time", "path": "time", "short": "Primitive Type time", "definition": "A time during the day, with no date specified", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/time.id", "resource": { "resourceType": "DataElement", "id": "time.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/time.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "time.id", "path": "time.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/time.value", "resource": { "resourceType": "DataElement", "id": "time.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/time.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "time.value", "path": "time.value", "representation": [ "xmlAttr" ], "short": "Primitive value for time", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?" } ], "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:time" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:time" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/decimal", "resource": { "resourceType": "DataElement", "id": "decimal", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/decimal", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "decimal", "path": "decimal", "short": "Primitive Type decimal", "definition": "A rational number with implicit precision", "comment": "Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/decimal.id", "resource": { "resourceType": "DataElement", "id": "decimal.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/decimal.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "decimal.id", "path": "decimal.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/decimal.value", "resource": { "resourceType": "DataElement", "id": "decimal.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/decimal.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "decimal.value", "path": "decimal.value", "representation": [ "xmlAttr" ], "short": "Primitive value for decimal", "definition": "The actual value", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "-?([0]|([1-9][0-9]*))(\\.[0-9]+)?" } ], "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "number" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:decimal" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:decimal" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/xhtml", "resource": { "resourceType": "DataElement", "id": "xhtml", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/xhtml", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "xhtml", "path": "xhtml", "short": "Primitive Type xhtml", "definition": "XHTML", "min": 0, "max": "*" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/xhtml.id", "resource": { "resourceType": "DataElement", "id": "xhtml.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/xhtml.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "xhtml.id", "path": "xhtml.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": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/xhtml.value", "resource": { "resourceType": "DataElement", "id": "xhtml.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/xhtml.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "xhtml.value", "path": "xhtml.value", "representation": [ "xhtml" ], "short": "Actual xhtml", "definition": "Actual xhtml", "min": 1, "max": "1", "type": [ { "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xhtml:div" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "string" } ] } } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Reference", "resource": { "resourceType": "DataElement", "id": "Reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Reference", "path": "Reference", "short": "A reference from one resource to another", "definition": "A reference from one resource to another.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Reference.reference", "resource": { "resourceType": "DataElement", "id": "Reference.reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Reference.reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Reference.reference", "path": "Reference.reference", "short": "Literal reference, Relative, internal or absolute URL", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "ref-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Reference.identifier", "resource": { "resourceType": "DataElement", "id": "Reference.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Reference.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Reference.identifier", "path": "Reference.identifier", "short": "Logical reference, when literal reference is not known", "definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Reference.display", "resource": { "resourceType": "DataElement", "id": "Reference.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Reference.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Reference.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Reference.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Quantity", "resource": { "resourceType": "DataElement", "id": "Quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Quantity", "path": "Quantity", "short": "A measured or measurable amount", "definition": "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.", "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL<PQ>, MO, CO, depending on the values" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Quantity.value", "resource": { "resourceType": "DataElement", "id": "Quantity.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Quantity.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Quantity.value", "path": "Quantity.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": 0, "max": "1", "type": [ { "code": "decimal" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Quantity.comparator", "resource": { "resourceType": "DataElement", "id": "Quantity.comparator", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Quantity.comparator", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Quantity.comparator", "path": "Quantity.comparator", "short": "< | <= | >= | > - 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.", "comment": "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.", "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", "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "description": "How the Quantity should be understood and represented.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/quantity-comparator" } }, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Quantity.unit", "resource": { "resourceType": "DataElement", "id": "Quantity.unit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Quantity.unit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Quantity.unit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Quantity.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": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Quantity.system", "resource": { "resourceType": "DataElement", "id": "Quantity.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Quantity.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Quantity.system", "path": "Quantity.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": 0, "max": "1", "type": [ { "code": "uri" } ], "condition": [ "qty-3" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Quantity.code", "resource": { "resourceType": "DataElement", "id": "Quantity.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Quantity.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Quantity.code", "path": "Quantity.code", "short": "Coded form of the unit", "definition": "A computer processable form of the unit in some unit representation system.", "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": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Period", "resource": { "resourceType": "DataElement", "id": "Period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Period", "path": "Period", "short": "Time range defined by start and end date/time", "definition": "A time period defined by a start and end date and optionally time.", "comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\"). If duration is required, specify the type as Interval|Duration.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.empty() or end.empty() or (start <= end)", "xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Period.start", "resource": { "resourceType": "DataElement", "id": "Period.start", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Period.start", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Period.start", "path": "Period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Period.end", "resource": { "resourceType": "DataElement", "id": "Period.end", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Period.end", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Period.end", "path": "Period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment", "resource": { "resourceType": "DataElement", "id": "Attachment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment", "path": "Attachment", "short": "Content in a format defined elsewhere", "definition": "For referring to data content defined in other formats.", "comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Attachment\".", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "att-1", "severity": "error", "human": "It the Attachment has data, it SHALL have a contentType", "expression": "data.empty() or contentType.exists()", "xpath": "not(exists(f:data)) or exists(f:contentType)" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ED/RP" }, { "identity": "rim", "map": "ED" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.contentType", "resource": { "resourceType": "DataElement", "id": "Attachment.contentType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.contentType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.contentType", "path": "Attachment.contentType", "short": "Mime type of the content, with charset etc.", "definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.", "requirements": "Processors of the data need to be able to know how to interpret the data.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "text/plain; charset=UTF-8, image/png" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" }, "mapping": [ { "identity": "v2", "map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used" }, { "identity": "rim", "map": "./mediaType, ./charset" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.language", "resource": { "resourceType": "DataElement", "id": "Attachment.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.language", "path": "Attachment.language", "short": "Human language of the content (BCP-47)", "definition": "The human language of the content. The value can be any valid value according to BCP 47.", "requirements": "Users need to be able to choose between the languages in a set of attachments.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "en-AU" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "mapping": [ { "identity": "rim", "map": "./language" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.data", "resource": { "resourceType": "DataElement", "id": "Attachment.data", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.data", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.data", "path": "Attachment.data", "short": "Data inline, base64ed", "definition": "The actual data of the attachment - a sequence of bytes. In XML, represented using base64.", "comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.", "requirements": "The data needs to able to be transmitted inline.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" } ], "mapping": [ { "identity": "v2", "map": "ED.5" }, { "identity": "rim", "map": "./data" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.url", "resource": { "resourceType": "DataElement", "id": "Attachment.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.url", "path": "Attachment.url", "short": "Uri where the data can be found", "definition": "An alternative location where the data can be accessed.", "comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.", "requirements": "The data needs to be transmitted by reference.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "example": [ { "label": "General", "valueUri": "http://www.acme.com/logo-small.png" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "RP.1+RP.2 - if they refer to a URL (see v2.6)" }, { "identity": "rim", "map": "./reference/literal" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.size", "resource": { "resourceType": "DataElement", "id": "Attachment.size", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.size", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.size", "path": "Attachment.size", "short": "Number of bytes of content (if url provided)", "definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).", "comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.", "requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (needs data type R3 proposal)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.hash", "resource": { "resourceType": "DataElement", "id": "Attachment.hash", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.hash", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.hash", "path": "Attachment.hash", "short": "Hash of the data (sha-1, base64ed)", "definition": "The calculated hash of the data using SHA-1. Represented using base64.", "comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded.", "requirements": "Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.title", "resource": { "resourceType": "DataElement", "id": "Attachment.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.title", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Attachment.title", "short": "Label to display in place of the data", "definition": "A label or set of text to display in place of the data.", "requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Official Corporate Logo" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./title/data" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Attachment.creation", "resource": { "resourceType": "DataElement", "id": "Attachment.creation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Attachment.creation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Attachment.creation", "path": "Attachment.creation", "short": "Date attachment was first created", "definition": "The date that the attachment was first created.", "requirements": "This is often tracked as an integrity issue for use of the attachment.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (needs data type R3 proposal)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Duration", "resource": { "resourceType": "DataElement", "id": "Duration", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Duration", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Duration", "path": "Duration", "short": "A length of time", "definition": "A length of time.", "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min": 0, "max": "*", "constraint": [ { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "Quantity" }, { "key": "drt-1", "severity": "error", "human": "There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.", "expression": "code.exists() implies ((system = %ucum) and value.exists())", "xpath": "(f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='http://unitsofmeasure.org')" } ], "mapping": [ { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL<PQ>, MO, CO, depending on the values" }, { "identity": "rim", "map": "PQ, IVL<PQ> depending on the values" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Count", "resource": { "resourceType": "DataElement", "id": "Count", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Count", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Count", "path": "Count", "short": "A measured or measurable amount", "definition": "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.", "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min": 0, "max": "*", "constraint": [ { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "Quantity" }, { "key": "cnt-3", "severity": "error", "human": "There SHALL be a code with a value of \"1\" if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM. If present, the value SHALL a whole number.", "expression": "(code or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.toString().contains('.').not())", "xpath": "(f:code or not(f:value)) and (not(exists(f:system)) or (f:system/@value='http://unitsofmeasure.org' and f:code/@value='1')) and not(contains(f:value/@value, '.'))" } ], "mapping": [ { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL<PQ>, MO, CO, depending on the values" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Range", "resource": { "resourceType": "DataElement", "id": "Range", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Range", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Range", "path": "Range", "short": "Set of values bounded by low and high", "definition": "A set of ordered Quantities defined by a low and high limit.", "comment": "The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "rng-2", "severity": "error", "human": "If present, low SHALL have a lower value than high", "expression": "low.empty() or high.empty() or (low <= high)", "xpath": "not(exists(f:low/f:value/@value)) or not(exists(f:high/f:value/@value)) or (number(f:low/f:value/@value) <= number(f:high/f:value/@value))" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "NR and also possibly SN (but see also quantity)" }, { "identity": "rim", "map": "IVL<QTY[not(type=\"TS\")]> [lowClosed=\"true\" and highClosed=\"true\"]or URG<QTY[not(type=\"TS\")]>" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Range.low", "resource": { "resourceType": "DataElement", "id": "Range.low", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Range.low", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Range.low", "path": "Range.low", "short": "Low limit", "definition": "The low limit. The boundary is inclusive.", "comment": "If the low element is missing, the low boundary is not known.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "condition": [ "rng-2" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "NR.1" }, { "identity": "rim", "map": "./low" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Range.high", "resource": { "resourceType": "DataElement", "id": "Range.high", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Range.high", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Range.high", "path": "Range.high", "short": "High limit", "definition": "The high limit. The boundary is inclusive.", "comment": "If the high element is missing, the high boundary is not known.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "condition": [ "rng-2" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "NR.2" }, { "identity": "rim", "map": "./high" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Annotation", "resource": { "resourceType": "DataElement", "id": "Annotation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Annotation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Annotation", "path": "Annotation", "short": "Text node with attribution", "definition": "A text note which also contains information about who made the statement and when.", "comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Annotation.authorX", "resource": { "resourceType": "DataElement", "id": "Annotation.authorX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Annotation.authorX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Annotation.author[x]", "path": "Annotation.author[x]", "short": "Individual responsible for the annotation", "definition": "The individual responsible for making the annotation.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.participant[typeCode=AUT].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Annotation.time", "resource": { "resourceType": "DataElement", "id": "Annotation.time", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Annotation.time", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Annotation.time", "path": "Annotation.time", "short": "When the annotation was made", "definition": "Indicates when this particular annotation was made.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Annotation.text", "resource": { "resourceType": "DataElement", "id": "Annotation.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Annotation.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Annotation.text", "path": "Annotation.text", "short": "The annotation - text content", "definition": "The text of the annotation.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Money", "resource": { "resourceType": "DataElement", "id": "Money", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Money", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Money", "path": "Money", "short": "An amount of economic utility in some recognized currency", "definition": "An amount of economic utility in some recognized currency.", "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min": 0, "max": "*", "constraint": [ { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "Quantity" }, { "key": "mny-1", "severity": "error", "human": "There SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = \"urn:iso:std:iso:4217\" - currency).", "expression": "(code or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')", "xpath": "(f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='urn:iso:std:iso:4217')" } ], "mapping": [ { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL<PQ>, MO, CO, depending on the values" }, { "identity": "rim", "map": "MO" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Identifier", "resource": { "resourceType": "DataElement", "id": "Identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Identifier", "path": "Identifier", "short": "An identifier intended for computation", "definition": "A technical identifier - identifies some entity uniquely and unambiguously.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Identifier.use", "resource": { "resourceType": "DataElement", "id": "Identifier.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Identifier.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Identifier.use", "path": "Identifier.use", "short": "usual | official | temp | secondary (If known)", "definition": "The purpose of this identifier.", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Identifier.type", "resource": { "resourceType": "DataElement", "id": "Identifier.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Identifier.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Identifier.type", "path": "Identifier.type", "short": "Description of identifier", "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-type" } }, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Identifier.system", "resource": { "resourceType": "DataElement", "id": "Identifier.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Identifier.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Identifier.system", "path": "Identifier.system", "short": "The namespace for the identifier value", "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Identifier.value", "resource": { "resourceType": "DataElement", "id": "Identifier.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Identifier.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Identifier.value", "path": "Identifier.value", "short": "The value that is unique", "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).", "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "123456" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Identifier.period", "resource": { "resourceType": "DataElement", "id": "Identifier.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Identifier.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Identifier.period", "path": "Identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Identifier.assigner", "resource": { "resourceType": "DataElement", "id": "Identifier.assigner", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Identifier.assigner", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Identifier.assigner", "path": "Identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Coding", "resource": { "resourceType": "DataElement", "id": "Coding", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Coding", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Coding", "path": "Coding", "short": "A reference to a 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.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Coding.system", "resource": { "resourceType": "DataElement", "id": "Coding.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Coding.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Coding.system", "path": "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 de-reference to some definition that establish the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Coding.version", "resource": { "resourceType": "DataElement", "id": "Coding.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Coding.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Coding.version", "path": "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", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Coding.code", "resource": { "resourceType": "DataElement", "id": "Coding.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Coding.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Coding.code", "path": "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": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Coding.display", "resource": { "resourceType": "DataElement", "id": "Coding.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Coding.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "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", "type": [ { "code": "string" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Coding.userSelected", "resource": { "resourceType": "DataElement", "id": "Coding.userSelected", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Coding.userSelected", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Coding.userSelected", "path": "Coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - i.e. 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", "type": [ { "code": "boolean" } ], "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 ]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Signature", "resource": { "resourceType": "DataElement", "id": "Signature", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Signature", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Signature", "path": "Signature", "short": "A digital Signature - XML DigSig, JWT, Graphical image of signature, etc.", "definition": "A digital signature along with supporting context. The signature may be electronic/cryptographic in nature, or a graphical image representing a hand-written signature, or a signature process. Different signature approaches have different utilities.", "comment": "The elements of the Signature Resource are for ease of access of these elements. Foro digital signatures (Xml DigSig, JWT), 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": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Signature.type", "resource": { "resourceType": "DataElement", "id": "Signature.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Signature.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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/StructureDefinition/elementdefinition-bindingName", "valueString": "SignatureType" } ], "strength": "preferred", "description": "An indication of the reason that an entity signed the object", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/signature-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Signature.when", "resource": { "resourceType": "DataElement", "id": "Signature.when", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Signature.when", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Signature.whoX", "resource": { "resourceType": "DataElement", "id": "Signature.whoX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Signature.whoX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Signature.who[x]", "path": "Signature.who[x]", "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": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Signature.onBehalfOfX", "resource": { "resourceType": "DataElement", "id": "Signature.onBehalfOfX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Signature.onBehalfOfX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Signature.onBehalfOf[x]", "path": "Signature.onBehalfOf[x]", "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": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Signature.contentType", "resource": { "resourceType": "DataElement", "id": "Signature.contentType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Signature.contentType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Signature.contentType", "path": "Signature.contentType", "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/jwt for JWT, and image/* for a graphical image of a signature, etc.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Signature.blob", "resource": { "resourceType": "DataElement", "id": "Signature.blob", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Signature.blob", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Signature.blob", "path": "Signature.blob", "short": "The actual signature content (XML DigSig. JWT, 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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData", "resource": { "resourceType": "DataElement", "id": "SampledData", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData", "path": "SampledData", "short": "A series of measurements taken by a device", "definition": "A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.", "comment": "The data is not interpretable without at least origin, period, and dimensions, but these are optional to allow a separation between the template of measurement and the actual measurement, such as between DeviceCapabilities and DeviceLog. When providing a summary view (for example with Observation.value[x]) SampledData should be represented with a brief display text such as \"Sampled Data\".", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A (but see section 7.14 in v2.7)" }, { "identity": "rim", "map": "SLIST + GLIST" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData.origin", "resource": { "resourceType": "DataElement", "id": "SampledData.origin", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData.origin", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData.origin", "path": "SampledData.origin", "short": "Zero value and units", "definition": "The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.", "min": 1, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "SLIST.origin" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData.period", "resource": { "resourceType": "DataElement", "id": "SampledData.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData.period", "path": "SampledData.period", "short": "Number of milliseconds between samples", "definition": "The length of time between sampling times, measured in milliseconds.", "comment": "This is usually a whole number.", "min": 1, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "GLIST.increment" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData.factor", "resource": { "resourceType": "DataElement", "id": "SampledData.factor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData.factor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData.factor", "path": "SampledData.factor", "short": "Multiply data by this before adding to origin", "definition": "A correction factor that is applied to the sampled data points before they are added to the origin.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "defaultValueDecimal": 1, "isSummary": true, "mapping": [ { "identity": "rim", "map": "SLIST.factor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData.lowerLimit", "resource": { "resourceType": "DataElement", "id": "SampledData.lowerLimit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData.lowerLimit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData.lowerLimit", "path": "SampledData.lowerLimit", "short": "Lower limit of detection", "definition": "The lower limit of detection of the measured points. This is needed if any of the data points have the value \"L\" (lower than detection limit).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (use SLIST.digits.nullFlavor)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData.upperLimit", "resource": { "resourceType": "DataElement", "id": "SampledData.upperLimit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData.upperLimit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData.upperLimit", "path": "SampledData.upperLimit", "short": "Upper limit of detection", "definition": "The upper limit of detection of the measured points. This is needed if any of the data points have the value \"U\" (higher than detection limit).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (use SLIST.digits.nullFlavor)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData.dimensions", "resource": { "resourceType": "DataElement", "id": "SampledData.dimensions", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData.dimensions", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData.dimensions", "path": "SampledData.dimensions", "short": "Number of sample points at each time point", "definition": "The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.", "comment": "If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data).", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (fixed to 1)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SampledData.data", "resource": { "resourceType": "DataElement", "id": "SampledData.data", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SampledData.data", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SampledData.data", "path": "SampledData.data", "short": "Decimal values with spaces, or \"E\" | \"U\" | \"L\"", "definition": "A series of data points which are decimal values separated by a single space (character u20). The special values \"E\" (error), \"L\" (below detection limit) and \"U\" (above detection limit) can also be used in place of a decimal value.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "SLIST.digits" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Ratio", "resource": { "resourceType": "DataElement", "id": "Ratio", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Ratio", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Ratio", "path": "Ratio", "short": "A ratio of two Quantity values - a numerator and a denominator", "definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "rat-1", "severity": "error", "human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present", "expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())", "xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "RTO" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Ratio.numerator", "resource": { "resourceType": "DataElement", "id": "Ratio.numerator", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Ratio.numerator", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Ratio.numerator", "path": "Ratio.numerator", "short": "Numerator value", "definition": "The value of the numerator.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".numerator" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Ratio.denominator", "resource": { "resourceType": "DataElement", "id": "Ratio.denominator", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Ratio.denominator", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Ratio.denominator", "path": "Ratio.denominator", "short": "Denominator value", "definition": "The value of the denominator.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".denominator" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Distance", "resource": { "resourceType": "DataElement", "id": "Distance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Distance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Distance", "path": "Distance", "short": "A length - a value with a unit that is a physical distance", "definition": "A length - a value with a unit that is a physical distance.", "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min": 0, "max": "*", "constraint": [ { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "Quantity" }, { "key": "dis-1", "severity": "error", "human": "There SHALL be a code if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM.", "expression": "(code or value.empty()) and (system.empty() or system = %ucum)", "xpath": "(f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='http://unitsofmeasure.org')" } ], "mapping": [ { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL<PQ>, MO, CO, depending on the values" }, { "identity": "rim", "map": "PQ" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Age", "resource": { "resourceType": "DataElement", "id": "Age", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Age", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Age", "path": "Age", "short": "A duration of time during which an organism (or a process) has existed", "definition": "A duration of time during which an organism (or a process) has existed.", "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min": 0, "max": "*", "constraint": [ { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "Quantity" }, { "key": "age-1", "severity": "error", "human": "There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.", "expression": "(code or value.empty()) and (system.empty() or system = %ucum) and (value.empty() or value > 0)", "xpath": "(f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='http://unitsofmeasure.org') and (not(f:value/@value) or f:value/@value >=0)" } ], "mapping": [ { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL<PQ>, MO, CO, depending on the values" }, { "identity": "rim", "map": "PQ" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CodeableConcept", "resource": { "resourceType": "DataElement", "id": "CodeableConcept", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CodeableConcept", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CodeableConcept", "path": "CodeableConcept", "short": "Concept - reference to a terminology or just text", "definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CodeableConcept.coding", "resource": { "resourceType": "DataElement", "id": "CodeableConcept.coding", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CodeableConcept.coding", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CodeableConcept.coding", "path": "CodeableConcept.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 translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CodeableConcept.text", "resource": { "resourceType": "DataElement", "id": "CodeableConcept.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CodeableConcept.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CodeableConcept.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "CodeableConcept.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", "type": [ { "code": "string" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Meta", "resource": { "resourceType": "DataElement", "id": "Meta", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Meta", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Meta", "path": "Meta", "short": "Metadata about a resource", "definition": "The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Meta.versionId", "resource": { "resourceType": "DataElement", "id": "Meta.versionId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Meta.versionId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Meta.versionId", "path": "Meta.versionId", "short": "Version specific identifier", "definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.", "comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Meta.lastUpdated", "resource": { "resourceType": "DataElement", "id": "Meta.lastUpdated", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Meta.lastUpdated", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Meta.lastUpdated", "path": "Meta.lastUpdated", "short": "When the resource version last changed", "definition": "When the resource last changed - e.g. when the version changed.", "comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Meta.profile", "resource": { "resourceType": "DataElement", "id": "Meta.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Meta.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Meta.profile", "path": "Meta.profile", "short": "Profiles this resource claims to conform to", "definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url]().", "comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Meta.security", "resource": { "resourceType": "DataElement", "id": "Meta.security", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Meta.security", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Meta.security", "path": "Meta.security", "short": "Security Labels applied to this resource", "definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", "comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Meta.tag", "resource": { "resourceType": "DataElement", "id": "Meta.tag", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Meta.tag", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Meta.tag", "path": "Meta.tag", "short": "Tags applied to this resource", "definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Tags" } ], "strength": "example", "description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/common-tags" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address", "resource": { "resourceType": "DataElement", "id": "Address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address", "path": "Address", "short": "An address expressed using postal conventions (as opposed to GPS or other location definition formats)", "definition": "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.", "comment": "Note: address is for postal addresses, not physical locations.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD" }, { "identity": "rim", "map": "AD" }, { "identity": "servd", "map": "Address" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.use", "resource": { "resourceType": "DataElement", "id": "Address.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.use", "path": "Address.use", "short": "home | work | temp | old - purpose of this address", "definition": "The purpose of this address.", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "requirements": "Allows an appropriate address to be chosen from a list of many.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "home" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "description": "The use of an address", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-use" } }, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.type", "resource": { "resourceType": "DataElement", "id": "Address.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.type", "path": "Address.type", "short": "postal | physical | both", "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "both" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "description": "The type of an address (physical / postal)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-type" } }, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.text", "resource": { "resourceType": "DataElement", "id": "Address.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.text", "path": "Address.text", "short": "Text representation of the address", "definition": "A full text representation of the address.", "comment": "Can provide both a text representation and parts.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" }, { "identity": "vcard", "map": "address label parameter" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.line", "resource": { "resourceType": "DataElement", "id": "Address.line", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.line", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.line", "path": "Address.line", "short": "Street name, number, direction & P.O. Box etc.", "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "requirements": "home | work | temp | old - purpose of this address.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.city", "resource": { "resourceType": "DataElement", "id": "Address.city", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.city", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.city", "path": "Address.city", "short": "Name of city, town etc.", "definition": "The name of the city, town, village or other community or delivery center.", "alias": [ "Municpality" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Erewhon" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.district", "resource": { "resourceType": "DataElement", "id": "Address.district", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.district", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.district", "path": "Address.district", "short": "District name (aka county)", "definition": "The name of the administrative area (county).", "comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.", "alias": [ "County" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Madison" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.state", "resource": { "resourceType": "DataElement", "id": "Address.state", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.state", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.state", "path": "Address.state", "short": "Sub-unit of country (abbreviations ok)", "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.postalCode", "resource": { "resourceType": "DataElement", "id": "Address.postalCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.postalCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.postalCode", "path": "Address.postalCode", "short": "Postal code for area", "definition": "A postal code designating a region defined by the postal service.", "alias": [ "Zip" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "9132" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.country", "resource": { "resourceType": "DataElement", "id": "Address.country", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.country", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.country", "path": "Address.country", "short": "Country (e.g. can be ISO 3166 2 or 3 letter code)", "definition": "Country - a nation as commonly understood or generally accepted.", "comment": "ISO 3166 3 letter codes can be used in place of a full country name.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Address.period", "resource": { "resourceType": "DataElement", "id": "Address.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Address.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Address.period", "path": "Address.period", "short": "Time period when address was/is in use", "definition": "Time period when address was/is in use.", "requirements": "Allows addresses to be placed in historical context.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "example": [ { "label": "General", "valuePeriod": { "start": "2010-03-23", "end": "2010-07-01" } } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/TriggerDefinition", "resource": { "resourceType": "DataElement", "id": "TriggerDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/TriggerDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "TriggerDefinition", "path": "TriggerDefinition", "short": "Defines an expected trigger for a module", "definition": "A description of a triggering event.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/TriggerDefinition.type", "resource": { "resourceType": "DataElement", "id": "TriggerDefinition.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/TriggerDefinition.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "TriggerDefinition.type", "path": "TriggerDefinition.type", "short": "named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended", "definition": "The type of triggering event.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TriggerType" } ], "strength": "required", "description": "The type of trigger", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/trigger-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/TriggerDefinition.eventName", "resource": { "resourceType": "DataElement", "id": "TriggerDefinition.eventName", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/TriggerDefinition.eventName", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "TriggerDefinition.eventName", "path": "TriggerDefinition.eventName", "short": "Triggering event name", "definition": "The name of the event (if this is a named-event trigger).", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/TriggerDefinition.eventTimingX", "resource": { "resourceType": "DataElement", "id": "TriggerDefinition.eventTimingX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/TriggerDefinition.eventTimingX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "TriggerDefinition.eventTiming[x]", "path": "TriggerDefinition.eventTiming[x]", "short": "Timing of the event", "definition": "The timing of the event (if this is a period trigger).", "min": 0, "max": "1", "type": [ { "code": "Timing" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Schedule" }, { "code": "date" }, { "code": "dateTime" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/TriggerDefinition.eventData", "resource": { "resourceType": "DataElement", "id": "TriggerDefinition.eventData", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/TriggerDefinition.eventData", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "TriggerDefinition.eventData", "path": "TriggerDefinition.eventData", "short": "Triggering data of the event", "definition": "The triggering data of the event (if this is a data trigger).", "min": 0, "max": "1", "type": [ { "code": "DataRequirement" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contributor", "resource": { "resourceType": "DataElement", "id": "Contributor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contributor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contributor", "path": "Contributor", "short": "Contributor information", "definition": "A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contributor.type", "resource": { "resourceType": "DataElement", "id": "Contributor.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contributor.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contributor.type", "path": "Contributor.type", "short": "author | editor | reviewer | endorser", "definition": "The type of contributor.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContributorType" } ], "strength": "required", "description": "The type of contributor", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contributor-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contributor.name", "resource": { "resourceType": "DataElement", "id": "Contributor.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contributor.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contributor.name", "path": "Contributor.name", "short": "Who contributed the content", "definition": "The name of the individual or organization responsible for the contribution.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contributor.contact", "resource": { "resourceType": "DataElement", "id": "Contributor.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contributor.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contributor.contact", "path": "Contributor.contact", "short": "Contact details of the contributor", "definition": "Contact details to assist a user in finding and communicating with the contributor.", "min": 0, "max": "*", "type": [ { "code": "ContactDetail" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement", "resource": { "resourceType": "DataElement", "id": "DataRequirement", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement", "path": "DataRequirement", "short": "Describes a required data item", "definition": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.type", "resource": { "resourceType": "DataElement", "id": "DataRequirement.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.type", "path": "DataRequirement.type", "short": "The type of the required data", "definition": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRAllTypes" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "Either an abstract type, a resource or a data type.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/all-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.profile", "resource": { "resourceType": "DataElement", "id": "DataRequirement.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.profile", "path": "DataRequirement.profile", "short": "The profile of the required data", "definition": "The profile of the required data, specified as the uri of the profile definition.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.mustSupport", "resource": { "resourceType": "DataElement", "id": "DataRequirement.mustSupport", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.mustSupport", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.mustSupport", "path": "DataRequirement.mustSupport", "short": "Indicates that specific structure elements are referenced by the knowledge module", "definition": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter", "resource": { "resourceType": "DataElement", "id": "DataRequirement.codeFilter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.codeFilter", "path": "DataRequirement.codeFilter", "short": "What codes are expected", "definition": "Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.path", "resource": { "resourceType": "DataElement", "id": "DataRequirement.codeFilter.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.codeFilter.path", "path": "DataRequirement.codeFilter.path", "short": "The code-valued attribute of the filter", "definition": "The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueSetX", "resource": { "resourceType": "DataElement", "id": "DataRequirement.codeFilter.valueSetX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueSetX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.codeFilter.valueSet[x]", "path": "DataRequirement.codeFilter.valueSet[x]", "short": "Valueset for the filter", "definition": "The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.", "min": 0, "max": "1", "type": [ { "code": "string" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueCode", "resource": { "resourceType": "DataElement", "id": "DataRequirement.codeFilter.valueCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.codeFilter.valueCode", "path": "DataRequirement.codeFilter.valueCode", "short": "What code is expected", "definition": "The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueCoding", "resource": { "resourceType": "DataElement", "id": "DataRequirement.codeFilter.valueCoding", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueCoding", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.codeFilter.valueCoding", "path": "DataRequirement.codeFilter.valueCoding", "short": "What Coding is expected", "definition": "The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueCodeableConcept", "resource": { "resourceType": "DataElement", "id": "DataRequirement.codeFilter.valueCodeableConcept", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.codeFilter.valueCodeableConcept", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.codeFilter.valueCodeableConcept", "path": "DataRequirement.codeFilter.valueCodeableConcept", "short": "What CodeableConcept is expected", "definition": "The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.dateFilter", "resource": { "resourceType": "DataElement", "id": "DataRequirement.dateFilter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.dateFilter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.dateFilter", "path": "DataRequirement.dateFilter", "short": "What dates/date ranges are expected", "definition": "Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.dateFilter.path", "resource": { "resourceType": "DataElement", "id": "DataRequirement.dateFilter.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.dateFilter.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.dateFilter.path", "path": "DataRequirement.dateFilter.path", "short": "The date-valued attribute of the filter", "definition": "The date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timing.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DataRequirement.dateFilter.valueX", "resource": { "resourceType": "DataElement", "id": "DataRequirement.dateFilter.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DataRequirement.dateFilter.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DataRequirement.dateFilter.value[x]", "path": "DataRequirement.dateFilter.value[x]", "short": "The value of the filter, as a Period, DateTime, or Duration value", "definition": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Duration" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage", "resource": { "resourceType": "DataElement", "id": "Dosage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage", "path": "Dosage", "short": "How the medication is/was taken or should be taken", "definition": "Indicates how the medication is/was taken or should be taken by the patient.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.sequence", "resource": { "resourceType": "DataElement", "id": "Dosage.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.sequence", "path": "Dosage.sequence", "short": "The order of the dosage instructions", "definition": "Indicates the order in which the dosage instructions should be applied or interpreted.", "requirements": "If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.text", "resource": { "resourceType": "DataElement", "id": "Dosage.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.text", "path": "Dosage.text", "short": "Free text dosage instructions e.g. SIG", "definition": "Free text dosage instructions e.g. SIG.", "requirements": "Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.additionalInstruction", "resource": { "resourceType": "DataElement", "id": "Dosage.additionalInstruction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.additionalInstruction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.additionalInstruction", "path": "Dosage.additionalInstruction", "short": "Supplemental instruction - e.g. \"with meals\"", "definition": "Supplemental instruction - e.g. \"with meals\".", "requirements": "Additional instruction such as \"Swallow with plenty of water\" which may or may not be coded.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdditionalInstruction" } ], "strength": "example", "description": "A coded concept identifying additional instructions such as \"take with water\" or \"avoid operating heavy machinery\".", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/additional-instruction-codes" } }, "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.patientInstruction", "resource": { "resourceType": "DataElement", "id": "Dosage.patientInstruction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.patientInstruction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.patientInstruction", "path": "Dosage.patientInstruction", "short": "Patient or consumer oriented instructions", "definition": "Instructions in terms that are understood by the patient or consumer.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.timing", "resource": { "resourceType": "DataElement", "id": "Dosage.timing", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.timing", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.timing", "path": "Dosage.timing", "short": "When medication should be administered", "definition": "When medication should be administered.", "comment": "This attribute may not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.", "requirements": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.", "min": 0, "max": "1", "type": [ { "code": "Timing" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.asNeededX", "resource": { "resourceType": "DataElement", "id": "Dosage.asNeededX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.asNeededX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.asNeeded[x]", "path": "Dosage.asNeeded[x]", "short": "Take \"as needed\" (for x)", "definition": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).", "comment": "Can express \"as needed\" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express \"as needed\" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not \"prn\" or \"as needed\".", "min": 0, "max": "1", "type": [ { "code": "boolean" }, { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAsNeededReason" } ], "strength": "example", "description": "A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\" etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code=\"as needed\"].value=boolean or codable concept" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.site", "resource": { "resourceType": "DataElement", "id": "Dosage.site", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.site", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.site", "path": "Dosage.site", "short": "Body site to administer to", "definition": "Body site to administer to.", "comment": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html). May be a summary code, or a reference to a very precise definition of the location, or both.", "requirements": "A coded specification of the anatomic site where the medication first enters the body.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationSite" } ], "strength": "example", "description": "A coded concept describing the site location the medicine enters into or onto the body.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/approach-site-codes" } }, "mapping": [ { "identity": "rim", "map": ".approachSiteCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.route", "resource": { "resourceType": "DataElement", "id": "Dosage.route", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.route", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.route", "path": "Dosage.route", "short": "How drug should enter body", "definition": "How drug should enter body.", "requirements": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RouteOfAdministration" } ], "strength": "example", "description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/route-codes" } }, "mapping": [ { "identity": "rim", "map": ".routeCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.method", "resource": { "resourceType": "DataElement", "id": "Dosage.method", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.method", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.method", "path": "Dosage.method", "short": "Technique for administering medication", "definition": "Technique for administering medication.", "comment": "Terminologies used often pre-coordinate this term with the route and or form of administration.", "requirements": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationMethod" } ], "strength": "example", "description": "A coded concept describing the technique by which the medicine is administered.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/administration-method-codes" } }, "mapping": [ { "identity": "rim", "map": ".doseQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.doseX", "resource": { "resourceType": "DataElement", "id": "Dosage.doseX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.doseX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.dose[x]", "path": "Dosage.dose[x]", "short": "Amount of medication per dose", "definition": "Amount of medication per dose.", "comment": "Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.", "requirements": "The amount of therapeutic or other substance given at one administration event.", "min": 0, "max": "1", "type": [ { "code": "Range" }, { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".doseQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.maxDosePerPeriod", "resource": { "resourceType": "DataElement", "id": "Dosage.maxDosePerPeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.maxDosePerPeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.maxDosePerPeriod", "path": "Dosage.maxDosePerPeriod", "short": "Upper limit on medication per unit of time", "definition": "Upper limit on medication per unit of time.", "comment": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example \"2 tablets every 4 hours to a maximum of 8/day\".", "requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.", "min": 0, "max": "1", "type": [ { "code": "Ratio" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".maxDoseQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.maxDosePerAdministration", "resource": { "resourceType": "DataElement", "id": "Dosage.maxDosePerAdministration", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.maxDosePerAdministration", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.maxDosePerAdministration", "path": "Dosage.maxDosePerAdministration", "short": "Upper limit on medication per administration", "definition": "Upper limit on medication per administration.", "comment": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.", "requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "not supported" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.maxDosePerLifetime", "resource": { "resourceType": "DataElement", "id": "Dosage.maxDosePerLifetime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.maxDosePerLifetime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.maxDosePerLifetime", "path": "Dosage.maxDosePerLifetime", "short": "Upper limit on medication per lifetime of the patient", "definition": "Upper limit on medication per lifetime of the patient.", "requirements": "The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "not supported" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Dosage.rateX", "resource": { "resourceType": "DataElement", "id": "Dosage.rateX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Dosage.rateX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Dosage.rate[x]", "path": "Dosage.rate[x]", "short": "Amount of medication per unit of time", "definition": "Amount of medication per unit of time.", "comment": "It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.", "requirements": "Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.", "min": 0, "max": "1", "type": [ { "code": "Ratio" }, { "code": "Range" }, { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".rateQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedArtifact", "resource": { "resourceType": "DataElement", "id": "RelatedArtifact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedArtifact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedArtifact", "path": "RelatedArtifact", "short": "Related artifacts for a knowledge resource", "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.", "comment": "Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedArtifact.type", "resource": { "resourceType": "DataElement", "id": "RelatedArtifact.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedArtifact.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedArtifact.type", "path": "RelatedArtifact.type", "short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of", "definition": "The type of relationship to the related artifact.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RelatedArtifactType" } ], "strength": "required", "description": "The type of relationship to the related artifact", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/related-artifact-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedArtifact.display", "resource": { "resourceType": "DataElement", "id": "RelatedArtifact.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedArtifact.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedArtifact.display", "path": "RelatedArtifact.display", "short": "Brief description of the related artifact", "definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedArtifact.citation", "resource": { "resourceType": "DataElement", "id": "RelatedArtifact.citation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedArtifact.citation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedArtifact.citation", "path": "RelatedArtifact.citation", "short": "Bibliographic citation for the artifact", "definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.", "comment": "Additional structured information about citations should be captured as extensions.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedArtifact.url", "resource": { "resourceType": "DataElement", "id": "RelatedArtifact.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedArtifact.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedArtifact.url", "path": "RelatedArtifact.url", "short": "Where the artifact can be accessed", "definition": "A url for the artifact that can be followed to access the actual content.", "comment": "If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedArtifact.document", "resource": { "resourceType": "DataElement", "id": "RelatedArtifact.document", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedArtifact.document", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedArtifact.document", "path": "RelatedArtifact.document", "short": "What document is being referenced", "definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element.", "min": 0, "max": "1", "type": [ { "code": "Attachment" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedArtifact.resource", "resource": { "resourceType": "DataElement", "id": "RelatedArtifact.resource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedArtifact.resource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedArtifact.resource", "path": "RelatedArtifact.resource", "short": "What resource is being referenced", "definition": "The related resource, such as a library, value set, profile, or other knowledge resource.", "comment": "If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactDetail", "resource": { "resourceType": "DataElement", "id": "ContactDetail", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactDetail", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactDetail", "path": "ContactDetail", "short": "Contact information", "definition": "Specifies contact information for a person or organization.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactDetail.name", "resource": { "resourceType": "DataElement", "id": "ContactDetail.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactDetail.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactDetail.name", "path": "ContactDetail.name", "short": "Name of an individual to contact", "definition": "The name of an individual to contact.", "comment": "If there is no named individual, the telecom information is for the organization as a whole.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactDetail.telecom", "resource": { "resourceType": "DataElement", "id": "ContactDetail.telecom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactDetail.telecom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactDetail.telecom", "path": "ContactDetail.telecom", "short": "Contact details for individual or organization", "definition": "The contact details for the individual (if a name was provided) or the organization.", "min": 0, "max": "*", "type": [ { "code": "ContactPoint" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName", "resource": { "resourceType": "DataElement", "id": "HumanName", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName", "path": "HumanName", "short": "Name of a human - parts and usage", "definition": "A human's name with the ability to identify parts and usage.", "comment": "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XPN" }, { "identity": "rim", "map": "EN (actually, PN)" }, { "identity": "servd", "map": "ProviderName" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName.use", "resource": { "resourceType": "DataElement", "id": "HumanName.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName.use", "path": "HumanName.use", "short": "usual | official | temp | nickname | anonymous | old | maiden", "definition": "Identifies the purpose for this name.", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse" } ], "strength": "required", "description": "The use of a human name", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/name-use" } }, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName.text", "resource": { "resourceType": "DataElement", "id": "HumanName.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName.text", "path": "HumanName.text", "short": "Text representation of the full name", "definition": "A full text representation of the name.", "comment": "Can provide both a text representation and structured parts.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName.family", "resource": { "resourceType": "DataElement", "id": "HumanName.family", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName.family", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName.family", "path": "HumanName.family", "short": "Family name (often called 'Surname')", "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "alias": [ "surname" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.1/FN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName.given", "resource": { "resourceType": "DataElement", "id": "HumanName.given", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName.given", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName.given", "path": "HumanName.given", "short": "Given names (not always 'first'). Includes middle names", "definition": "Given name.", "comment": "If only initials are recorded, they may be used in place of the full name. Not called \"first name\" since given names do not always come first.", "alias": [ "first name", "middle name" ], "min": 0, "max": "*", "type": [ { "code": "string" } ], "orderMeaning": "Given Names appear in the correct order for presenting the name", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName.prefix", "resource": { "resourceType": "DataElement", "id": "HumanName.prefix", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName.prefix", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName.prefix", "path": "HumanName.prefix", "short": "Parts that come before the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "orderMeaning": "Prefixes appear in the correct order for presenting the name", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName.suffix", "resource": { "resourceType": "DataElement", "id": "HumanName.suffix", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName.suffix", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName.suffix", "path": "HumanName.suffix", "short": "Parts that come after the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "orderMeaning": "Suffixes appear in the correct order for presenting the name", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/HumanName.period", "resource": { "resourceType": "DataElement", "id": "HumanName.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/HumanName.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "HumanName.period", "path": "HumanName.period", "short": "Time period when name was/is in use", "definition": "Indicates the period of time when this name was valid for the named person.", "requirements": "Allows names to be placed in historical context.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactPoint", "resource": { "resourceType": "DataElement", "id": "ContactPoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactPoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactPoint", "path": "ContactPoint", "short": "Details of a Technology mediated contact point (phone, fax, email, etc.)", "definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "cpt-2", "severity": "error", "human": "A system is required if a value is provided.", "expression": "value.empty() or system.exists()", "xpath": "not(exists(f:value)) or exists(f:system)" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XTN" }, { "identity": "rim", "map": "TEL" }, { "identity": "servd", "map": "ContactPoint" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactPoint.system", "resource": { "resourceType": "DataElement", "id": "ContactPoint.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactPoint.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactPoint.system", "path": "ContactPoint.system", "short": "phone | fax | email | pager | url | sms | other", "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "condition": [ "cpt-2" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointSystem" } ], "strength": "required", "description": "Telecommunications form for contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-system" } }, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactPoint.value", "resource": { "resourceType": "DataElement", "id": "ContactPoint.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactPoint.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactPoint.value", "path": "ContactPoint.value", "short": "The actual contact point details", "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactPoint.use", "resource": { "resourceType": "DataElement", "id": "ContactPoint.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactPoint.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactPoint.use", "path": "ContactPoint.use", "short": "home | work | temp | old | mobile - purpose of this contact point", "definition": "Identifies the purpose for the contact point.", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointUse" } ], "strength": "required", "description": "Use of contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-use" } }, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactPoint.rank", "resource": { "resourceType": "DataElement", "id": "ContactPoint.rank", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactPoint.rank", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactPoint.rank", "path": "ContactPoint.rank", "short": "Specify preferred order of use (1 = highest)", "definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.", "comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ContactPoint.period", "resource": { "resourceType": "DataElement", "id": "ContactPoint.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ContactPoint.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ContactPoint.period", "path": "ContactPoint.period", "short": "Time period when the contact point was/is in use", "definition": "Time period when the contact point was/is in use.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/UsageContext", "resource": { "resourceType": "DataElement", "id": "UsageContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/UsageContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "UsageContext", "path": "UsageContext", "short": "Describes the context of use for a conformance or knowledge resource", "definition": "Specifies clinical/business/etc metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/UsageContext.code", "resource": { "resourceType": "DataElement", "id": "UsageContext.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/UsageContext.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "UsageContext.code", "path": "UsageContext.code", "short": "Type of context being specified", "definition": "A code that identifies the type of context being specified by this usage context.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "UsageContextType" } ], "strength": "extensible", "description": "A code that specifies a type of context being specified by a usage context", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/usage-context-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/UsageContext.valueX", "resource": { "resourceType": "DataElement", "id": "UsageContext.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/UsageContext.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "UsageContext.value[x]", "path": "UsageContext.value[x]", "short": "Value that defines the context", "definition": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Quantity" }, { "code": "Range" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "UsageContextValue" } ], "strength": "example", "description": "A code that defines the specific value for the context being specified", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/use-context" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing", "resource": { "resourceType": "DataElement", "id": "Timing", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing", "path": "Timing", "short": "A timing schedule that specifies an event that may occur multiple times", "definition": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.", "comment": "A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "QSET<TS> (GTS)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.event", "resource": { "resourceType": "DataElement", "id": "Timing.event", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.event", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.event", "path": "Timing.event", "short": "When the event occurs", "definition": "Identifies specific times when the event occurs.", "requirements": "In an MAR, for instance, you need to take a general specification, and turn it into a precise specification.", "min": 0, "max": "*", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "QLIST<TS>" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat", "resource": { "resourceType": "DataElement", "id": "Timing.repeat", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat", "path": "Timing.repeat", "short": "When the event is to occur", "definition": "A set of rules that describe when the event is scheduled.", "requirements": "Many timing schedules are determined by regular repetitions.", "min": 0, "max": "1", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "tim-9", "severity": "error", "human": "If there's an offset, there must be a when (and not C, CM, CD, CV)", "expression": "offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))", "xpath": "not(exists(f:offset)) or exists(f:when)" }, { "key": "tim-5", "severity": "error", "human": "period SHALL be a non-negative value", "expression": "period.exists() implies period >= 0", "xpath": "f:period/@value >= 0 or not(f:period/@value)" }, { "key": "tim-6", "severity": "error", "human": "If there's a periodMax, there must be a period", "expression": "periodMax.empty() or period.exists()", "xpath": "not(exists(f:periodMax)) or exists(f:period)" }, { "key": "tim-7", "severity": "error", "human": "If there's a durationMax, there must be a duration", "expression": "durationMax.empty() or duration.exists()", "xpath": "not(exists(f:durationMax)) or exists(f:duration)" }, { "key": "tim-8", "severity": "error", "human": "If there's a countMax, there must be a count", "expression": "countMax.empty() or count.exists()", "xpath": "not(exists(f:countMax)) or exists(f:count)" }, { "key": "tim-1", "severity": "error", "human": "if there's a duration, there needs to be duration units", "expression": "duration.empty() or durationUnit.exists()", "xpath": "not(exists(f:duration)) or exists(f:durationUnit)" }, { "key": "tim-10", "severity": "error", "human": "If there's a timeOfDay, there cannot be be a when, or vice versa", "expression": "timeOfDay.empty() or when.empty()", "xpath": "not(exists(f:timeOfDay)) or not(exists(f:when))" }, { "key": "tim-2", "severity": "error", "human": "if there's a period, there needs to be period units", "expression": "period.empty() or periodUnit.exists()", "xpath": "not(exists(f:period)) or exists(f:periodUnit)" }, { "key": "tim-4", "severity": "error", "human": "duration SHALL be a non-negative value", "expression": "duration.exists() implies duration >= 0", "xpath": "f:duration/@value >= 0 or not(f:duration/@value)" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Implies PIVL or EIVL" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.boundsX", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.boundsX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.boundsX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.bounds[x]", "path": "Timing.repeat.bounds[x]", "short": "Length/Range of lengths, or (Start and/or end) limits", "definition": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", "min": 0, "max": "1", "type": [ { "code": "Duration" }, { "code": "Range" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "IVL(TS) used in a QSI" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.count", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.count", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.count", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.count", "path": "Timing.repeat.count", "short": "Number of times to repeat", "definition": "A total count of the desired number of repetitions.", "comment": "If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.", "requirements": "Repetitions may be limited by end time or total occurrences.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.count" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.countMax", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.countMax", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.countMax", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.countMax", "path": "Timing.repeat.countMax", "short": "Maximum number of times to repeat", "definition": "A maximum value for the count of the desired repetitions (e.g. do something 6-8 times).", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.count" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.duration", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.duration", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.duration", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.duration", "path": "Timing.repeat.duration", "short": "How long when it happens", "definition": "How long this thing happens for when it happens.", "comment": "For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).", "requirements": "Some activities are not instantaneous and need to be maintained for a period of time.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.durationMax", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.durationMax", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.durationMax", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.durationMax", "path": "Timing.repeat.durationMax", "short": "How long when it happens (Max)", "definition": "The upper limit of how long this thing happens for when it happens.", "comment": "For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).", "requirements": "Some activities are not instantaneous and need to be maintained for a period of time.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.durationUnit", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.durationUnit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.durationUnit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.durationUnit", "path": "Timing.repeat.durationUnit", "short": "s | min | h | d | wk | mo | a - unit of time (UCUM)", "definition": "The units of time for the duration, in UCUM units.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "UnitsOfTime" } ], "strength": "required", "description": "A unit of time (units from UCUM).", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/units-of-time" } }, "mapping": [ { "identity": "rim", "map": "PIVL.phase.unit" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.frequency", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.frequency", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.frequency", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.frequency", "path": "Timing.repeat.frequency", "short": "Event occurs frequency times per period", "definition": "The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "defaultValueInteger": 1, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.frequencyMax", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.frequencyMax", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.frequencyMax", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.frequencyMax", "path": "Timing.repeat.frequencyMax", "short": "Event occurs up to frequencyMax times per period", "definition": "If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.period", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.period", "path": "Timing.repeat.period", "short": "Event occurs frequency times per period", "definition": "Indicates the duration of time over which repetitions are to occur; e.g. to express \"3 times per day\", 3 would be the frequency and \"1 day\" would be the period.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.periodMax", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.periodMax", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.periodMax", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.periodMax", "path": "Timing.repeat.periodMax", "short": "Upper limit of period (3-4 hours)", "definition": "If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as \"do this once every 3-5 days.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.periodUnit", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.periodUnit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.periodUnit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.periodUnit", "path": "Timing.repeat.periodUnit", "short": "s | min | h | d | wk | mo | a - unit of time (UCUM)", "definition": "The units of time for the period in UCUM units.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "UnitsOfTime" } ], "strength": "required", "description": "A unit of time (units from UCUM).", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/units-of-time" } }, "mapping": [ { "identity": "rim", "map": "PIVL.phase.unit" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.dayOfWeek", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.dayOfWeek", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.dayOfWeek", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.dayOfWeek", "path": "Timing.repeat.dayOfWeek", "short": "mon | tue | wed | thu | fri | sat | sun", "definition": "If one or more days of week is provided, then the action happens only on the specified day(s).", "comment": "If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DayOfWeek" } ], "strength": "required", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/days-of-week" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.timeOfDay", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.timeOfDay", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.timeOfDay", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.timeOfDay", "path": "Timing.repeat.timeOfDay", "short": "Time of day for action", "definition": "Specified time of day for action to take place.", "comment": "When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.", "min": 0, "max": "*", "type": [ { "code": "time" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.when", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.when", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.when", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.when", "path": "Timing.repeat.when", "short": "Regular life events the event is tied to", "definition": "Real world events that the occurrence of the event should be tied to.", "comment": "When more than one event is listed, the event is tied to the union of the specified events.", "requirements": "Timings are frequently determined by occurrences such as waking, eating and sleep.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EventTiming" } ], "strength": "required", "description": "Real world event relating to the schedule.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/event-timing" } }, "mapping": [ { "identity": "rim", "map": "EIVL.event" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.repeat.offset", "resource": { "resourceType": "DataElement", "id": "Timing.repeat.offset", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.repeat.offset", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.repeat.offset", "path": "Timing.repeat.offset", "short": "Minutes from event (before or after)", "definition": "The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "EIVL.offset" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Timing.code", "resource": { "resourceType": "DataElement", "id": "Timing.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Timing.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Timing.code", "path": "Timing.code", "short": "BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H +", "definition": "A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).", "comment": "BID etc are defined as 'at institutionally specified times'. For example, an institution may choose that BID is \"always at 7am and 6pm\". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or the a structured representation should be used (in this case, specifying the two event times).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TimingAbbreviation" } ], "strength": "preferred", "description": "Code for a known / defined timing pattern.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/timing-abbreviation" } }, "mapping": [ { "identity": "rim", "map": "QSC.code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition", "resource": { "resourceType": "DataElement", "id": "ElementDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition", "path": "ElementDefinition", "short": "Definition of an element in a resource or extension", "definition": "Captures constraints on each element within the resource, profile, or extension.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "eld-2", "severity": "error", "human": "Min <= Max", "expression": "min.empty() or max.empty() or (max = '*') or (min <= max.toInteger())", "xpath": "not(exists(f:min)) or not(exists(f:max)) or (not(f:max/@value) and not(f:min/@value)) or (f:max/@value = '*') or (number(f:max/@value) >= f:min/@value)" }, { "key": "eld-5", "severity": "error", "human": "if the element definition has a contentReference, it cannot have type, defaultValue, fixed, pattern, example, minValue, maxValue, maxLength, or binding", "expression": "contentReference.empty() or (type.empty() and defaultValue.empty() and fixed.empty() and pattern.empty() and example.empty() and minValue.empty() and maxValue.empty() and maxLength.empty() and binding.empty())", "xpath": "not(exists(f:contentReference) and (exists(f:type) or exists(f:*[starts-with(local-name(.), 'value')]) or exists(f:*[starts-with(local-name(.), 'defaultValue')]) or exists(f:*[starts-with(local-name(.), 'fixed')]) or exists(f:*[starts-with(local-name(.), 'pattern')]) or exists(f:*[starts-with(local-name(.), 'example')]) or exists(f:*[starts-with(local-name(.), 'f:minValue')]) or exists(f:*[starts-with(local-name(.), 'f:maxValue')]) or exists(f:maxLength) or exists(f:binding)))" }, { "key": "eld-7", "severity": "error", "human": "Pattern may only be specified if there is one type", "expression": "pattern.empty() or (type.count() <= 1)", "xpath": "not(exists(f:*[starts-with(local-name(.), 'pattern')])) or (count(f:type)<=1)" }, { "key": "eld-6", "severity": "error", "human": "Fixed value may only be specified if there is one type", "expression": "fixed.empty() or (type.count() <= 1)", "xpath": "not(exists(f:*[starts-with(local-name(.), 'fixed')])) or (count(f:type)<=1)" }, { "key": "eld-11", "severity": "error", "human": "Binding can only be present for coded elements, string, and uri", "expression": "binding.empty() or type.code.empty() or type.select((code = 'code') or (code = 'Coding') or (code='CodeableConcept') or (code = 'Quantity') or (code = 'Extension') or (code = 'string') or (code = 'uri')).exists()", "xpath": "not(exists(f:binding)) or (count(f:type/f:code) = 0) or f:type/f:code/@value=('code','Coding','CodeableConcept','Quantity','Extension', 'string', 'uri')" }, { "key": "eld-8", "severity": "error", "human": "Pattern and value are mutually exclusive", "expression": "pattern.empty() or fixed.empty()", "xpath": "not(exists(f:*[starts-with(local-name(.), 'pattern')])) or not(exists(f:*[starts-with(local-name(.), 'fixed')]))" }, { "key": "eld-14", "severity": "error", "human": "Constraints must be unique by key", "expression": "constraint.select(key).isDistinct()", "xpath": "count(f:constraint) = count(distinct-values(f:constraint/f:key/@value))" }, { "key": "eld-13", "severity": "error", "human": "Types must be unique by the combination of code and profile", "expression": "type.select(code&profile&targetProfile).isDistinct()", "xpath": "not(exists(for $type in f:type return $type/preceding-sibling::f:type[f:code/@value=$type/f:code/@value and f:profile/@value = $type/f:profile/@value]))" }, { "key": "eld-16", "severity": "error", "human": "sliceName must be composed of proper tokens separated by \"/\"", "expression": "sliceName.empty() or sliceName.matches('^[a-zA-Z0-9\\\\/\\\\-\\\\_]+$')", "xpath": "not(exists(f:sliceName/@value)) or matches(f:sliceName/@value, '^[a-zA-Z0-9\\\\/\\\\-\\\\_]+$')" }, { "key": "eld-15", "severity": "error", "human": "default value and meaningWhenMissing are mutually exclusive", "expression": "defaultValue.empty() or meaningWhenMissing.empty()", "xpath": "not(exists(f:*[starts-with(local-name(.), 'fixed')])) or not(exists(f:meaningWhenMissing))" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "dex", "map": "RetrieveMetadata response" }, { "identity": "v2", "map": "OM1" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=DEFN]" }, { "identity": "iso11179", "map": "Data_Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.path", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.path", "path": "ElementDefinition.path", "short": "Path of the element in the hierarchy of elements", "definition": "The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource or extension.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "Name, Identifier & Context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.representation", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.representation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.representation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.representation", "path": "ElementDefinition.representation", "short": "xmlAttr | xmlText | typeAttr | cdaText | xhtml", "definition": "Codes that define how this element is represented in instances, when the deviation varies from the normal case.", "comment": "In resources, this is rarely used except for special cases where the representation deviates from the normal, and can only be done in the base standard (and profiles must reproduce what the base standard does). This element is used quite commonly in Logical models when the logical models represent a specific serialization format (e.g. CDA, v2 etc).", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PropertyRepresentation" } ], "strength": "required", "description": "How a property is represented when serialized.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/property-representation" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.sliceName", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.sliceName", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.sliceName", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.sliceName", "path": "ElementDefinition.sliceName", "short": "Name for this particular element (in a set of slices)", "definition": "The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.", "comment": "The name SHALL be unique within the structure within the context of the constrained resource element. (Though to avoid confusion, uniqueness across all elements is recommended.).", "requirements": "May also be used for code generation purposes.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.label", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.label", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.label", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.label", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.label", "short": "Name for element to display with or prompt for element", "definition": "A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.", "comment": "See also the extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-question)[extension-elementdefinition-question.html].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./code/display" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.code", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.code", "path": "ElementDefinition.code", "short": "Corresponding codes in terminologies", "definition": "A code that has the same meaning as the element in a particular terminology.", "comment": "The concept SHALL be properly aligned with the data element definition and other constraints, as defined in the code system, including relationships, of any code listed here. Where multiple codes exist in a terminology that could correspond to the data element, the most granular code(s) should be selected, so long as they are not more restrictive than the data element itself. The mappings may be used to provide more or less granular or structured equivalences in the code system.", "requirements": "Links the meaning of an element to an external terminology, and is very useful for searching and indexing.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ElementDefinitionCode" } ], "strength": "example", "description": "Codes that indicate the meaning of a data element.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-codes" } }, "mapping": [ { "identity": "v2", "map": "OM1.7" }, { "identity": "rim", "map": "./code (root or translation)" }, { "identity": "iso11179", "map": "(Data_Element).data_element_concept.identifier" }, { "identity": "loinc", "map": "LOINC_NUM" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.slicing", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.slicing", "path": "ElementDefinition.slicing", "short": "This element is sliced - slices follow", "definition": "Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).", "comment": "The first element in the sequence, the one that carries the slicing, is the definition that applies to all the slices. This is based on the unconstrained element, but can apply any constraints as appropriate. This may include the common constraints on the children of the element.", "min": 0, "max": "1", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "eld-1", "severity": "error", "human": "If there are no discriminators, there must be a definition", "expression": "discriminator.exists() or description.exists()", "xpath": "(f:discriminator) or (f:description)" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.discriminator", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.slicing.discriminator", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.discriminator", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.slicing.discriminator", "path": "ElementDefinition.slicing.discriminator", "short": "Element values that are used to distinguish the slices", "definition": "Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.", "comment": "If there is no discriminator, the content is hard to process, so this should be avoided. If the base element has a cardinality of ..1, and there is a choice of types, the discriminator must be \"@type\".", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.discriminator.type", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.slicing.discriminator.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.discriminator.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.slicing.discriminator.type", "path": "ElementDefinition.slicing.discriminator.type", "short": "value | exists | pattern | type | profile", "definition": "How the element value is interpreted when discrimination is evaluated.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiscriminatorType" } ], "strength": "required", "description": "How an element value is interpreted when discrimination is evaluated", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/discriminator-type" } }, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.discriminator.path", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.slicing.discriminator.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.discriminator.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.slicing.discriminator.path", "path": "ElementDefinition.slicing.discriminator.path", "short": "Path to element value", "definition": "A FHIRPath expression, using a restricted subset of FHIRPath, that is used to identify the element on which discrimination is based.", "comment": "The only FHIRPath functions that are allowed are resolve(), and extension(url).", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.description", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.slicing.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.slicing.description", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.slicing.description", "short": "Text description of how slicing works (or not)", "definition": "A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.", "comment": "If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "eld-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.ordered", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.slicing.ordered", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.ordered", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.slicing.ordered", "path": "ElementDefinition.slicing.ordered", "short": "If elements must be in same order as slices", "definition": "If the matching elements have to occur in the same order as defined in the profile.", "comment": "Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.rules", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.slicing.rules", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.slicing.rules", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.slicing.rules", "path": "ElementDefinition.slicing.rules", "short": "closed | open | openAtEnd", "definition": "Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.", "comment": "Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SlicingRules" } ], "strength": "required", "description": "How slices are interpreted when evaluating an instance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-slicing-rules" } }, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.short", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.short", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.short", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.short", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.short", "short": "Concise definition for space-constrained presentation", "definition": "A concise description of what this element means (e.g. for use in autogenerated summaries).", "comment": "May change the term to provide language more appropriate to the context of the profile or to reflect slicing.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.definition", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.definition", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.definition", "short": "Full formal definition as narrative text", "definition": "Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.", "comment": "It is easy for a different definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing definitions.", "requirements": "To allow a user to state the usage of an element in a particular context.", "alias": [ "Description" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OM1.6, OM1.41" }, { "identity": "rim", "map": "./text" }, { "identity": "iso11179", "map": "(Designatable_Item).definition.text acceptability=preferred in default context" }, { "identity": "loinc", "map": "TERM DEFINITION/DESCRIPTION(S)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.comment", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.comment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.comment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.comment", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.comment", "short": "Comments about the use of this element", "definition": "Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.", "comment": "If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "NTE, OM1.32, OM1.33, OM1.39" }, { "identity": "rim", "map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code" }, { "identity": "iso11179", "map": "(Administered_Item).explanatory_comment" }, { "identity": "loinc", "map": "COMMENTS" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.requirements", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.requirements", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.requirements", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.requirements", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.requirements", "short": "Why this resource has been created", "definition": "This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.", "comment": "This element does not describe the usage of the element (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./inboundRelationship[typeCode=META]/source[classCode=ACT, moodCode=EVN, isCriterionInd=true]/reasonCode/originalText" }, { "identity": "iso11179", "map": "(Registered_item).document_reference[document_type=requirements].notation" }, { "identity": "loinc", "map": "R/O/C" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.alias", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.alias", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.alias", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.alias", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.alias", "short": "Other names", "definition": "Identifies additional names by which this element might also be known.", "requirements": "Allows for better easier recognition of the element by multiple communities, including international communities.", "alias": [ "synonym", "other name" ], "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OM1.8, OM1.52" }, { "identity": "rim", "map": "Not currently expressible" }, { "identity": "iso11179", "map": "(Designatable_Item).designation.sign acceptability!=preferred or context is other than default" }, { "identity": "loinc", "map": "RELATED NAMES (only some of these apply)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.min", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.min", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.min", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.min", "path": "ElementDefinition.min", "short": "Minimum Cardinality", "definition": "The minimum number of times this element SHALL appear in the instance.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "condition": [ "eld-2" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "Minimum size of data element values?" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.max", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.max", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.max", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.max", "path": "ElementDefinition.max", "short": "Maximum Cardinality (a number or *)", "definition": "The maximum number of times this element is permitted to appear in the instance.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "eld-3", "eld-2" ], "constraint": [ { "key": "eld-3", "severity": "error", "human": "Max SHALL be a number or \"*\"", "expression": "empty() or ($this = '*') or (toInteger() >= 0)", "xpath": "@value='*' or (normalize-space(@value)!='' and normalize-space(translate(@value, '0123456789',''))='')" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OMC.10" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "Maximum size of data element values?" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.base", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.base", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.base", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.base", "path": "ElementDefinition.base", "short": "Base definition information for tools", "definition": "Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. This information is provided when the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot.", "comment": "The base information does not carry any information that could not be determined from the path and related profiles, but making this determination requires both that the related profiles are available, and that the algorithm to determine them be available. So they are deformalised into this location for tooling convenience, and to ensure that the base information is available without dependencies.", "min": 0, "max": "1", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.base.path", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.base.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.base.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.base.path", "path": "ElementDefinition.base.path", "short": "Path that identifies the base element", "definition": "The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [StructureDefinition](structuredefinition.html#) without a StructureDefinition.base.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.base.min", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.base.min", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.base.min", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.base.min", "path": "ElementDefinition.base.min", "short": "Min cardinality of the base element", "definition": "Minimum cardinality of the base element identified by the path.", "comment": "This is provided for consistency with max, and may affect code generation of mandatory elements of the base resource are generated differently (some reference implementations have done this).", "min": 1, "max": "1", "type": [ { "code": "unsignedInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.base.max", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.base.max", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.base.max", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.base.max", "path": "ElementDefinition.base.max", "short": "Max cardinality of the base element", "definition": "Maximum cardinality of the base element identified by the path.", "comment": "This is provided to code generation, since the serialization representation in JSON differs depending on whether the base element has max > 1. Also, some forms of code generation may differ.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.contentReference", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.contentReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.contentReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.contentReference", "path": "ElementDefinition.contentReference", "short": "Reference to definition of content for the element", "definition": "Identifies the identity of an element defined elsewhere in the profile whose content rules should be applied to the current element.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "condition": [ "eld-5" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.type", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "TypeRef" } ], "path": "ElementDefinition.type", "short": "Data type and Profile for this element", "definition": "The data type or resource that the value of this element is permitted to be.", "comment": "The Type of the element can be left blank in a differential constraint, in which case the type is inherited from the resource. Abstract types are not permitted to appear as a type when multiple types are listed. (I.e. Abstract types cannot be part of a choice).", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "condition": [ "eld-13" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "eld-4", "severity": "error", "human": "Aggregation may only be specified if one of the allowed types for the element is a resource", "expression": "aggregation.empty() or (code = 'Reference')", "xpath": "not(exists(f:aggregation)) or exists(f:code[@value = 'Reference'])" } ], "isSummary": true, "mapping": [ { "identity": "dex", "map": "valueDomain.dataType" }, { "identity": "v2", "map": "OM1.3, OMC.9" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": ".domain.data+Q14type" }, { "identity": "loinc", "map": "HL7_V2_DATATYPE (translation required), HL7_V3_DATATYPE (translation required)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.type.code", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.type.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.type.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.type.code", "path": "ElementDefinition.type.code", "short": "Data type or Resource (reference to definition)", "definition": "URL of Data type or Resource that is a(or the) type used for this element. 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": "If the element is a reference to another resource, this element contains \"Reference\", and the targetProfile element defines what resources can be referenced. The targetProfile may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient). There would be one pair of type/code for each allowed target resource type.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRDefinedTypeExt" } ], "strength": "extensible", "description": "Either a resource or a data type, including logical model types", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/defined-types" } }, "mapping": [ { "identity": "v2", "map": "OM1.3" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": ".domain.data+Q14type" }, { "identity": "loinc", "map": "HL7_V2_DATATYPE (translation required), HL7_V3_DATATYPE (translation required)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.type.profile", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.type.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.type.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.type.profile", "path": "ElementDefinition.type.profile", "short": "Profile (StructureDefinition) to apply (or IG)", "definition": "Identifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.type.targetProfile", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.type.targetProfile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.type.targetProfile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.type.targetProfile", "path": "ElementDefinition.type.targetProfile", "short": "Profile (StructureDefinition) to apply to reference target (or IG)", "definition": "Identifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.type.aggregation", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.type.aggregation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.type.aggregation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.type.aggregation", "path": "ElementDefinition.type.aggregation", "short": "contained | referenced | bundled - how aggregated", "definition": "If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "condition": [ "eld-4" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AggregationMode" } ], "strength": "required", "description": "How resource references can be aggregated.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-aggregation-mode" } }, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.type.versioning", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.type.versioning", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.type.versioning", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.type.versioning", "path": "ElementDefinition.type.versioning", "short": "either | independent | specific", "definition": "Whether this reference needs to be version specific or version independent, or whether either can be used.", "comment": "The base specification never makes a rule as to which form is allowed, but implementation guides may do this.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "defaultValueCode": "either", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferenceVersionRules" } ], "strength": "required", "description": "Whether a reference needs to be version specific or version independent, or whether either can be used", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/reference-version-rules" } }, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.defaultValueX", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.defaultValueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.defaultValueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.defaultValue[x]", "path": "ElementDefinition.defaultValue[x]", "short": "Specified value if missing from instance", "definition": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').", "comment": "Default values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. Specifying a default value means that the property can never been unknown - it must always have a value. Further, the default value can never be changed. For these reasons, default values are (and should be) used extremely sparingly.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "condition": [ "eld-15" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.meaningWhenMissing", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.meaningWhenMissing", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.meaningWhenMissing", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.meaningWhenMissing", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.meaningWhenMissing", "short": "Implicit meaning when this element is missing", "definition": "The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'.", "comment": "Implicit meanings for missing values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. An implicit meaning for a missing value can never be changed, and specifying one has the consequence that constraining its use in profiles eliminates use cases as possibilities, not merely moving them out of scope.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "condition": [ "eld-15" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.orderMeaning", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.orderMeaning", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.orderMeaning", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.orderMeaning", "path": "ElementDefinition.orderMeaning", "short": "What the order of the elements means", "definition": "If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.", "comment": "This element can only be asserted on repeating elements and can only be introduced when defining resources or data types. It can be further refined profiled elements but if absent in the base type, a profile cannot assert meaning.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.fixedX", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.fixedX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.fixedX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.fixed[x]", "path": "ElementDefinition.fixed[x]", "short": "Value must be exactly this", "definition": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", "comment": "This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "condition": [ "eld-5", "eld-6", "eld-8" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "N/A (only relevant when constraining, which 11179 doesn't do)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.patternX", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.patternX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.patternX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.pattern[x]", "path": "ElementDefinition.pattern[x]", "short": "Value must have at least these property values", "definition": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).", "comment": "Mostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "condition": [ "eld-5", "eld-7", "eld-8" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.example", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.example", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.example", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.example", "path": "ElementDefinition.example", "short": "Example value (as defined for type)", "definition": "A sample value for this element demonstrating the type of information that would typically be found in the element.", "comment": "Examples will most commonly be present for data where it's not implicitly obvious from either the data type or value set what the values might be. (I.e. Example values for dates or quantities would generally be unnecessary.) If the example value is fully populated, the publication tool can generate an instance automatically.", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.example.label", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.example.label", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.example.label", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.example.label", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.example.label", "short": "Describes the purpose of this example", "definition": "Describes the purpose of this example amoung the set of examples.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.example.valueX", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.example.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.example.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.example.value[x]", "path": "ElementDefinition.example.value[x]", "short": "Value of Example (one of allowed types)", "definition": "The actual value for the element, which must be one of the types allowed for this element.", "min": 1, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": ".example" }, { "identity": "loinc", "map": "EXMPL_ANSWERS" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.minValueX", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.minValueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.minValueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.minValue[x]", "path": "ElementDefinition.minValue[x]", "short": "Minimum Allowed Value (for some types)", "definition": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", "comment": "Except for date/date/instant, the type of the minValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of minValue[x] SHALL be either the same, or a a [Duration](datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is subtracted from the current clock to determine the minimum allowable value. A minimum value for a Quantity is interpreted as an canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.", "min": 0, "max": "1", "type": [ { "code": "date" }, { "code": "dateTime" }, { "code": "instant" }, { "code": "time" }, { "code": "decimal" }, { "code": "integer" }, { "code": "positiveInt" }, { "code": "unsignedInt" }, { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.maxValueX", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.maxValueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.maxValueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.maxValue[x]", "path": "ElementDefinition.maxValue[x]", "short": "Maximum Allowed Value (for some types)", "definition": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", "comment": "Except for date/date/instant, the type of the maxValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of maxValue[x] SHALL be either the same, or a a [Duration](datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is added to the current clock to determine the maximum allowable value. A maximum value for a Quantity is interpreted as an canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.", "min": 0, "max": "1", "type": [ { "code": "date" }, { "code": "dateTime" }, { "code": "instant" }, { "code": "time" }, { "code": "decimal" }, { "code": "integer" }, { "code": "positiveInt" }, { "code": "unsignedInt" }, { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.maxLength", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.maxLength", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.maxLength", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.maxLength", "path": "ElementDefinition.maxLength", "short": "Max length for strings", "definition": "Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.", "comment": "Receivers are not required to reject instances that exceed the maximum length. The full length could be stored. In some cases, data might be truncated, though truncation should be undertaken with care and an understanding of the consequences of doing so. If not specified, there is no conformance expectation for length support.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OMC.12" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": ".domain.maximum_character_quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.condition", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.condition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.condition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.condition", "path": "ElementDefinition.condition", "short": "Reference to invariant about presence", "definition": "A reference to an invariant that may make additional statements about the cardinality or value in the instance.", "min": 0, "max": "*", "type": [ { "code": "id" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint", "path": "ElementDefinition.constraint", "short": "Condition that must evaluate to true", "definition": "Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.", "comment": "Constraints should be declared on the \"context\" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "??" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.key", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint.key", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.key", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint.key", "path": "ElementDefinition.constraint.key", "short": "Target of 'condition' reference above", "definition": "Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.", "min": 1, "max": "1", "type": [ { "code": "id" } ], "condition": [ "eld-14" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.requirements", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint.requirements", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.requirements", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint.requirements", "path": "ElementDefinition.constraint.requirements", "short": "Why this constraint is necessary or appropriate", "definition": "Description of why this constraint is necessary or appropriate.", "comment": "To be used if the reason for the constraint may not be intuitive to all implementers.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.severity", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint.severity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.severity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint.severity", "path": "ElementDefinition.constraint.severity", "short": "error | warning", "definition": "Identifies the impact constraint violation has on the conformance of the instance.", "comment": "This allows constraints to be asserted as \"shall\" (error) and \"should\" (warning).", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConstraintSeverity" } ], "strength": "required", "description": "SHALL applications comply with this constraint?", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/constraint-severity" } }, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.human", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint.human", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.human", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint.human", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.constraint.human", "short": "Human description of constraint", "definition": "Text that can be used to describe the constraint in messages identifying that the constraint has been violated.", "comment": "Should be expressed in business terms as much as possible.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.expression", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint.expression", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.expression", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint.expression", "path": "ElementDefinition.constraint.expression", "short": "FHIRPath expression of constraint", "definition": "A [FHIRPath](http://hl7.org/fluentpath) expression of constraint that can be executed to see if this constraint is met.", "requirements": "Used by validation tooling tests of the validity of the resource.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.xpath", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint.xpath", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.xpath", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint.xpath", "path": "ElementDefinition.constraint.xpath", "short": "XPath expression of constraint", "definition": "An XPath expression of constraint that can be executed to see if this constraint is met.", "comment": "Elements SHALL use \"f\" as the namespace prefix for the FHIR namespace, and \"x\" for the xhtml namespace, and SHALL NOT use any other prefixes. \n\nNote: we are considering deprecating the xpath element. Implementer feedback is welcome.", "requirements": "Used in Schematron tests of the validity of the resource.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.source", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.constraint.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.constraint.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.constraint.source", "path": "ElementDefinition.constraint.source", "short": "Reference to original source of constraint", "definition": "A reference to the original source of the constraint, for traceability purposes.", "comment": "This is used when, e.g. rendering, where it is not useful to present inherited constraints when rendering the snapshot.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.mustSupport", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.mustSupport", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.mustSupport", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.mustSupport", "path": "ElementDefinition.mustSupport", "short": "If the element must supported", "definition": "If true, implementations that produce or consume resources SHALL provide \"support\" for the element in some meaningful way. If false, the element may be ignored and not supported.", "comment": "\"Something useful\" is context dependent and impossible to describe in the base FHIR specification. For this reason, tue mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. \n\nThis is done in [Resource Profiles](profiling.html#mustsupport), where the profile labels an element as mustSupport=true. When a profile does this, it SHALL also make clear exactly what kind of \"support\" is required, as this can mean many things.\n\nNote that an element that has the property IsModifier is not necessarily a \"key\" element (e.g. one of the important elements to make use of the resource), nor is it automatically mustSupport - however both of these things are more likely to be true for IsModifier elements than for other elements.", "requirements": "Allows a profile to set expectations for system capabilities beyond merely respecting cardinality constraints.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "??" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.isModifier", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.isModifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.isModifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.isModifier", "path": "ElementDefinition.isModifier", "short": "If this modifies the meaning of other elements", "definition": "If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.", "comment": "Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.", "requirements": "Allows elements to be introduced into a specification that can't safely be ignored by applications that don't recognize them.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "??" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.isSummary", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.isSummary", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.isSummary", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.isSummary", "path": "ElementDefinition.isSummary", "short": "Include when _summary = true?", "definition": "Whether the element should be included if a client requests a search with the parameter _summary=true.", "comment": "Some resources include a set of simple metadata, and some very large data. This element is used to reduce the quantity of data returned in searches. Note that servers may pre-cache summarized resources for optimal performance, so servers may not support per-profile use of the isSummary flag. When a request is made with _summary=true, serailisers only include elements marked as 'isSummary = true'. Other than Attachment.data, all data type properties are included in the summary form. Modifier elements or elements with minimum cardinality = 1 must be marked as summary elements.", "requirements": "Allow clients to search through large resources quickly.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "??" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.binding", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.binding", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.binding", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.binding", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ElementDefinitionBinding" } ], "path": "ElementDefinition.binding", "short": "ValueSet details if this is coded", "definition": "Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).", "comment": "For a CodeableConcept, when no codes are allowed - only text, use a binding of strength \"required\" with a description explaining that no coded values are allowed and what sort of information to put in the \"text\" element.", "min": 0, "max": "1", "type": [ { "code": "Element" } ], "condition": [ "eld-11" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "eld-10", "severity": "error", "human": "provide either a reference or a description (or both)", "expression": "valueSet.exists() or description.exists()", "xpath": "(exists(f:valueSetUri) or exists(f:valueSetReference)) or exists(f:description)" }, { "key": "eld-12", "severity": "error", "human": "ValueSet as a URI SHALL start with http:// or https:// or urn:", "expression": "valueSet.is(uri).not() or valueSet.as(uri).startsWith('http:') or valueSet.as(uri).startsWith('https') or valueSet.as(uri).startsWith('urn:')", "xpath": "not(exists(f:valueSetUri)) or (starts-with(string(f:valueSetUri/@value), 'http:') or starts-with(string(f:valueSetUri/@value), 'https:') or starts-with(string(f:valueSetUri/@value), 'urn:'))" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OM3, OMC.11" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": ".domain" }, { "identity": "loinc", "map": "ANSWER LIST, NORMATIVE ANSWER LIST" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.binding.strength", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.binding.strength", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.binding.strength", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.binding.strength", "path": "ElementDefinition.binding.strength", "short": "required | extensible | preferred | example", "definition": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.", "comment": "For further discussion, see [Using Terminologies](terminologies.html).", "alias": [ "conformance", "extensibility" ], "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BindingStrength" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "Indication of the degree of conformance expectations associated with a binding.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/binding-strength" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "loinc", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.binding.description", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.binding.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.binding.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.binding.description", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "ElementDefinition.binding.description", "short": "Human explanation of the value set", "definition": "Describes the intended use of this particular set of codes.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "eld-10" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": ".domain.description" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.binding.valueSetX", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.binding.valueSetX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.binding.valueSetX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.binding.valueSet[x]", "path": "ElementDefinition.binding.valueSet[x]", "short": "Source of value set", "definition": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.", "comment": "For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.", "min": 0, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet" } ], "condition": [ "eld-10", "eld-12" ], "isSummary": true, "mapping": [ { "identity": "dex", "map": "valueDomain.valueSet" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "points to explicit list or expression that evaluates to list of (Enumerated_Value_Domain).member" }, { "identity": "loinc", "map": "CODE_TABLE" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.mapping", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.mapping", "path": "ElementDefinition.mapping", "short": "Map element to another set of definitions", "definition": "Identifies a concept from an external specification that roughly corresponds to this element.", "comment": "Mappings are not necessarily specific enough for safe translation.", "requirements": "Provides guidance to implementers familiar with or converting content from other specifications.", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "dex", "map": "mappingSpecification" }, { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "Registered_item).document_reference[document_type=mapping] Also, .meaning linkage to Data_Element_Concept is done as a mapping to a reference model. (Data_Element_Concepts are all defined in some sort of reference model, be that Object_Class and Property or some other mechanism)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.identity", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.mapping.identity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.identity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.mapping.identity", "path": "ElementDefinition.mapping.identity", "short": "Reference to mapping declaration", "definition": "An internal reference to the definition of a mapping.", "min": 1, "max": "1", "type": [ { "code": "id" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.language", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.mapping.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.mapping.language", "path": "ElementDefinition.mapping.language", "short": "Computable language of mapping", "definition": "Identifies the computable language in which mapping.map is expressed.", "comment": "If omitted, then there can be no expectation of computational interpretation of the mapping.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" }, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.map", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.mapping.map", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.map", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.mapping.map", "path": "ElementDefinition.mapping.map", "short": "Details of the mapping", "definition": "Expresses what part of the target specification corresponds to this element.", "comment": "For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "ObjectClass, Property (this is one possible data model that can be mapped to - the uri would identify the data model mappingSpecification.mappingScript" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.comment", "resource": { "resourceType": "DataElement", "id": "ElementDefinition.mapping.comment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ElementDefinition.mapping.comment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ElementDefinition.mapping.comment", "path": "ElementDefinition.mapping.comment", "short": "Comments about the mapping or its use", "definition": "Comments that provide information about the mapping or its use.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition", "path": "ParameterDefinition", "short": "Definition of a parameter to a module", "definition": "The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition.name", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition.name", "path": "ParameterDefinition.name", "short": "Name used to access the parameter value", "definition": "The name of the parameter used to allow access to the value of the parameter in evaluation contexts.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition.use", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition.use", "path": "ParameterDefinition.use", "short": "in | out", "definition": "Whether the parameter is input or output for the module.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParameterUse" } ], "strength": "required", "description": "Whether the parameter is input or output", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/operation-parameter-use" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition.min", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition.min", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition.min", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition.min", "path": "ParameterDefinition.min", "short": "Minimum cardinality", "definition": "The minimum number of times this parameter SHALL appear in the request or response.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition.max", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition.max", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition.max", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition.max", "path": "ParameterDefinition.max", "short": "Maximum cardinality (a number of *)", "definition": "The maximum number of times this element is permitted to appear in the request or response.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition.documentation", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition.documentation", "path": "ParameterDefinition.documentation", "short": "A brief description of the parameter", "definition": "A brief discussion of what the parameter is for and how it is used by the module.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition.type", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition.type", "path": "ParameterDefinition.type", "short": "What type of value", "definition": "The type of the parameter.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRAllTypes" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "Either an abstract type, a resource or a data type.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/all-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ParameterDefinition.profile", "resource": { "resourceType": "DataElement", "id": "ParameterDefinition.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ParameterDefinition.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ParameterDefinition.profile", "path": "ParameterDefinition.profile", "short": "What profile the value is expected to be", "definition": "If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Extension", "resource": { "resourceType": "DataElement", "id": "Extension", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Extension", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Extension", "path": "Extension", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "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')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Extension.url", "resource": { "resourceType": "DataElement", "id": "Extension.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Extension.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": [ { "code": "uri" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Extension.valueX", "resource": { "resourceType": "DataElement", "id": "Extension.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Extension.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 0, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BackboneElement", "resource": { "resourceType": "DataElement", "id": "BackboneElement", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BackboneElement", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BackboneElement", "path": "BackboneElement", "short": "Base for elements defined inside a resource", "definition": "Base definition for all elements that are defined inside a resource - but not those in a data type.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BackboneElement.modifierExtension", "resource": { "resourceType": "DataElement", "id": "BackboneElement.modifierExtension", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BackboneElement.modifierExtension", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BackboneElement.modifierExtension", "path": "BackboneElement.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Narrative", "resource": { "resourceType": "DataElement", "id": "Narrative", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Narrative", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Narrative", "path": "Narrative", "short": "A human-readable formatted text, including images", "definition": "A human-readable formatted text, including images.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Narrative.status", "resource": { "resourceType": "DataElement", "id": "Narrative.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Narrative.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Narrative.status", "path": "Narrative.status", "short": "generated | extensions | additional | empty", "definition": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NarrativeStatus" } ], "strength": "required", "description": "The status of a resource narrative", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/narrative-status" } }, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Narrative.div", "resource": { "resourceType": "DataElement", "id": "Narrative.div", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Narrative.div", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Narrative.div", "path": "Narrative.div", "short": "Limited xhtml content", "definition": "The actual narrative content, a stripped down version of XHTML.", "comment": "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.", "min": 1, "max": "1", "type": [ { "code": "xhtml" } ], "constraint": [ { "key": "txt-1", "severity": "error", "human": "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes", "expression": "htmlchecks()", "xpath": "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])" }, { "key": "txt-2", "severity": "error", "human": "The narrative SHALL have some non-whitespace content", "expression": "htmlchecks()", "xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Element", "resource": { "resourceType": "DataElement", "id": "Element", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Element", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Element", "path": "Element", "short": "Base for all elements", "definition": "Base definition for all elements in a resource.", "min": 0, "max": "*", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Element.id", "resource": { "resourceType": "DataElement", "id": "Element.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Element.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Element.id", "path": "Element.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Element.extension", "resource": { "resourceType": "DataElement", "id": "Element.extension", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Element.extension", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Element.extension", "path": "Element.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DomainResource", "resource": { "resourceType": "DataElement", "id": "DomainResource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DomainResource", "status": "draft", "experimental": true, "stringency": "fully-specified", "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()", "xpath": "not(parent::f:contained and f:contained)" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)" }, { "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))" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DomainResource.text", "resource": { "resourceType": "DataElement", "id": "DomainResource.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DomainResource.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DomainResource.contained", "resource": { "resourceType": "DataElement", "id": "DomainResource.contained", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DomainResource.contained", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DomainResource.extension", "resource": { "resourceType": "DataElement", "id": "DomainResource.extension", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DomainResource.extension", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DomainResource.modifierExtension", "resource": { "resourceType": "DataElement", "id": "DomainResource.modifierExtension", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DomainResource.modifierExtension", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Parameters", "resource": { "resourceType": "DataElement", "id": "Parameters", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Parameters", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Parameters", "path": "Parameters", "short": "Operation Request or Response", "definition": "This special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.", "comment": "The parameters that may be used are defined by the OperationDefinition resource.", "min": 0, "max": "*", "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "infrastructure.exchange" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Parameters.parameter", "resource": { "resourceType": "DataElement", "id": "Parameters.parameter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Parameters.parameter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Parameters.parameter", "path": "Parameters.parameter", "short": "Operation Parameter", "definition": "A parameter passed to or received from the operation.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "inv-1", "severity": "error", "human": "A parameter must have only one of (value, resource, part)", "expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))", "xpath": "exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource))" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Parameters.parameter.name", "resource": { "resourceType": "DataElement", "id": "Parameters.parameter.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Parameters.parameter.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Parameters.parameter.name", "path": "Parameters.parameter.name", "short": "Name from the definition", "definition": "The name of the parameter (reference to the operation definition).", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Parameters.parameter.valueX", "resource": { "resourceType": "DataElement", "id": "Parameters.parameter.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Parameters.parameter.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Parameters.parameter.value[x]", "path": "Parameters.parameter.value[x]", "short": "If parameter is a data type", "definition": "If the parameter is a data type.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "condition": [ "inv-1" ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Parameters.parameter.resource", "resource": { "resourceType": "DataElement", "id": "Parameters.parameter.resource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Parameters.parameter.resource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Parameters.parameter.resource", "path": "Parameters.parameter.resource", "short": "If parameter is a whole resource", "definition": "If the parameter is a whole resource.", "min": 0, "max": "1", "type": [ { "code": "Resource" } ], "condition": [ "inv-1" ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Parameters.parameter.part", "resource": { "resourceType": "DataElement", "id": "Parameters.parameter.part", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Parameters.parameter.part", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Parameters.parameter.part", "path": "Parameters.parameter.part", "short": "Named part of a multi-part parameter", "definition": "A named part of a multi-part parameter.", "comment": "Only one level of nested parameters is allowed.", "min": 0, "max": "*", "contentReference": "#Parameters.parameter", "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Resource", "resource": { "resourceType": "DataElement", "id": "Resource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Resource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Resource", "path": "Resource", "short": "Base Resource", "definition": "This is the base resource type for everything.", "min": 0, "max": "*", "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Resource.id", "resource": { "resourceType": "DataElement", "id": "Resource.id", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Resource.id", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Resource.meta", "resource": { "resourceType": "DataElement", "id": "Resource.meta", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Resource.meta", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 may not always be associated with version changes to the resource.", "min": 0, "max": "1", "type": [ { "code": "Meta" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Resource.implicitRules", "resource": { "resourceType": "DataElement", "id": "Resource.implicitRules", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Resource.implicitRules", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Resource.language", "resource": { "resourceType": "DataElement", "id": "Resource.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Resource.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment", "resource": { "resourceType": "DataElement", "id": "Appointment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment", "path": "Appointment", "short": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)", "definition": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "app-3", "severity": "error", "human": "Only proposed or cancelled appointments can be missing start/end dates", "expression": "(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))", "xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled'))" }, { "key": "app-2", "severity": "error", "human": "Either start and end are specified, or neither", "expression": "start.empty() xor end.exists()", "xpath": "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[@moodCode <= 'INT']" }, { "identity": "ical", "map": "VEVENT" }, { "identity": "w5", "map": "workflow.scheduling" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.identifier", "resource": { "resourceType": "DataElement", "id": "Appointment.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.identifier", "path": "Appointment.identifier", "short": "External Ids for this item", "definition": "This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SCH-1, SCH-2, ARQ-1, ARQ-2" }, { "identity": "rim", "map": ".id" }, { "identity": "ical", "map": "UID" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.status", "resource": { "resourceType": "DataElement", "id": "Appointment.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.status", "path": "Appointment.status", "short": "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error", "definition": "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.", "comment": "If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AppointmentStatus" } ], "strength": "required", "description": "The free/busy status of an appointment.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/appointmentstatus" } }, "mapping": [ { "identity": "v2", "map": "SCH-25" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.serviceCategory", "resource": { "resourceType": "DataElement", "id": "Appointment.serviceCategory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.serviceCategory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.serviceCategory", "path": "Appointment.serviceCategory", "short": "A broad categorisation of the service that is to be performed during this appointment", "definition": "A broad categorisation of the service that is to be performed during this appointment.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-category" } ], "strength": "example", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-category" } }, "mapping": [ { "identity": "rim", "map": "n/a, might be inferred from the ServiceDeliveryLocation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.serviceType", "resource": { "resourceType": "DataElement", "id": "Appointment.serviceType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.serviceType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.serviceType", "path": "Appointment.serviceType", "short": "The specific service that is to be performed during this appointment", "definition": "The specific service that is to be performed during this appointment.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-type" } ], "strength": "example", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-type" } }, "mapping": [ { "identity": "rim", "map": "n/a, might be inferred from the ServiceDeliveryLocation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.specialty", "resource": { "resourceType": "DataElement", "id": "Appointment.specialty", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.specialty", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.specialty", "path": "Appointment.specialty", "short": "The specialty of a practitioner that would be required to perform the service requested in this appointment", "definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "specialty" } ], "strength": "preferred", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, "mapping": [ { "identity": "rim", "map": ".performer.AssignedPerson.code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.appointmentType", "resource": { "resourceType": "DataElement", "id": "Appointment.appointmentType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.appointmentType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.appointmentType", "path": "Appointment.appointmentType", "short": "The style of appointment or patient that has been booked in the slot (not service type)", "definition": "The style of appointment or patient that has been booked in the slot (not service type).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "appointment-type" } ], "strength": "preferred", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0276" } }, "mapping": [ { "identity": "v2", "map": "ARQ-7" }, { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.reason", "resource": { "resourceType": "DataElement", "id": "Appointment.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.reason", "path": "Appointment.reason", "short": "Reason this appointment is scheduled", "definition": "The reason that this appointment is being scheduled. This is more clinical than administrative.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ApptReason" } ], "strength": "preferred", "description": "The Reason for the appointment to take place.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-reason" } }, "mapping": [ { "identity": "v2", "map": "AIS-3, SCH-7" }, { "identity": "rim", "map": ".reasonCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.indication", "resource": { "resourceType": "DataElement", "id": "Appointment.indication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.indication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.indication", "path": "Appointment.indication", "short": "Reason the appointment is to takes place (resource)", "definition": "Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[@typeCode = 'RSON'].observation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.priority", "resource": { "resourceType": "DataElement", "id": "Appointment.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.priority", "path": "Appointment.priority", "short": "Used to make informed decisions if needing to re-prioritize", "definition": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).", "comment": "Seeking implementer feedback on this property and how interoperable it is.\r\rUsing an extension to record a codeableconcept for named values may be tested at a future connectathon.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "mapping": [ { "identity": "v2", "map": "ARQ-12, SCH-11.6 / TQ1-9" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "ical", "map": "PRIORITY" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.description", "resource": { "resourceType": "DataElement", "id": "Appointment.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.description", "path": "Appointment.description", "short": "Shown on a subject line in a meeting request, or appointment list", "definition": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".text" }, { "identity": "ical", "map": "DESCRIPTION" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.supportingInformation", "resource": { "resourceType": "DataElement", "id": "Appointment.supportingInformation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.supportingInformation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.supportingInformation", "path": "Appointment.supportingInformation", "short": "Additional information to support the appointment", "definition": "Additional information to support the appointment provided when making the appointment.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[@typeCode = 'SPRT'].observation" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.start", "resource": { "resourceType": "DataElement", "id": "Appointment.start", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.start", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.start", "path": "Appointment.start", "short": "When appointment is to take place", "definition": "Date/Time that the appointment is to take place.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ARQ-11.1, SCH-11.4 / TQ1-7" }, { "identity": "rim", "map": ".effectiveTime.low" }, { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.end", "resource": { "resourceType": "DataElement", "id": "Appointment.end", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.end", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.end", "path": "Appointment.end", "short": "When appointment is to conclude", "definition": "Date/Time that the appointment is to conclude.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9" }, { "identity": "rim", "map": ".effectiveTime.high" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.minutesDuration", "resource": { "resourceType": "DataElement", "id": "Appointment.minutesDuration", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.minutesDuration", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.minutesDuration", "path": "Appointment.minutesDuration", "short": "Can be less than start/end (e.g. estimate)", "definition": "Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "rim", "map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.slot", "resource": { "resourceType": "DataElement", "id": "Appointment.slot", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.slot", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.slot", "path": "Appointment.slot", "short": "The slots that this appointment is filling", "definition": "The slots from the participants' schedules that will be filled by the appointment.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Slot" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.created", "resource": { "resourceType": "DataElement", "id": "Appointment.created", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.created", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.created", "path": "Appointment.created", "short": "The date that this appointment was initially created", "definition": "The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.", "comment": "This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "rim", "map": ".author.time" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.comment", "resource": { "resourceType": "DataElement", "id": "Appointment.comment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.comment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.comment", "path": "Appointment.comment", "short": "Additional comments", "definition": "Additional comments about the appointment.", "comment": "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" }, { "identity": "ical", "map": "COMMENT" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.incomingReferral", "resource": { "resourceType": "DataElement", "id": "Appointment.incomingReferral", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.incomingReferral", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.incomingReferral", "path": "Appointment.incomingReferral", "short": "The ReferralRequest provided as information to allocate to the Encounter", "definition": "The referral request this appointment is allocated to assess (incoming referral).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.participant", "resource": { "resourceType": "DataElement", "id": "Appointment.participant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.participant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.participant", "path": "Appointment.participant", "short": "Participants involved in appointment", "definition": "List of participants involved in the appointment.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "app-1", "severity": "error", "human": "Either the type or actor on the participant SHALL be specified", "expression": "type.exists() or actor.exists()", "xpath": "(exists(f:type) or exists(f:actor))" } ], "mapping": [ { "identity": "v2", "map": "PID, AIP, AIG, AIL" }, { "identity": "rim", "map": "performer | reusableDevice | subject | location" }, { "identity": "ical", "map": "ATTENDEE component to be created" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.participant.type", "resource": { "resourceType": "DataElement", "id": "Appointment.participant.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.participant.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.participant.type", "path": "Appointment.participant.type", "short": "Role of participant in the appointment", "definition": "Role of participant in the appointment.", "comment": "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipantType" } ], "strength": "extensible", "description": "Role of participant in encounter.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-participant-type" } }, "mapping": [ { "identity": "v2", "map": "AIP-4, AIG-4" }, { "identity": "rim", "map": "(performer | reusableDevice | subject | location).@typeCode" }, { "identity": "ical", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.participant.actor", "resource": { "resourceType": "DataElement", "id": "Appointment.participant.actor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.participant.actor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.participant.actor", "path": "Appointment.participant.actor", "short": "Person, Location/HealthcareService or Device", "definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3" }, { "identity": "rim", "map": "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation" }, { "identity": "ical", "map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not \"information-only\"" }, { "identity": "w5", "map": "who" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.participant.required", "resource": { "resourceType": "DataElement", "id": "Appointment.participant.required", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.participant.required", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.participant.required", "path": "Appointment.participant.required", "short": "required | optional | information-only", "definition": "Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipantRequired" } ], "strength": "required", "description": "Is the Participant required to attend the appointment.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/participantrequired" } }, "mapping": [ { "identity": "rim", "map": "(performer | reusableDevice | subject | location).@performInd" }, { "identity": "ical", "map": "ROLE=REQ-PARTICIPANT (roleparam)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.participant.status", "resource": { "resourceType": "DataElement", "id": "Appointment.participant.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.participant.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.participant.status", "path": "Appointment.participant.status", "short": "accepted | declined | tentative | needs-action", "definition": "Participation status of the actor.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipationStatus" } ], "strength": "required", "description": "The Participation status of an appointment.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/participationstatus" } }, "mapping": [ { "identity": "v2", "map": "AIP-12, AIG-14" }, { "identity": "rim", "map": "(performer | reusableDevice | subject | location).statusCode" }, { "identity": "ical", "map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Appointment.requestedPeriod", "resource": { "resourceType": "DataElement", "id": "Appointment.requestedPeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Appointment.requestedPeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Appointment.requestedPeriod", "path": "Appointment.requestedPeriod", "short": "Potential date/time interval(s) requested to allocate the appointment within", "definition": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.", "comment": "This does not introduce a capacity for recurring appointments.", "min": 0, "max": "*", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "v2", "map": "ARQ-11" }, { "identity": "rim", "map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest", "resource": { "resourceType": "DataElement", "id": "ReferralRequest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest", "path": "ReferralRequest", "short": "A request for referral or transfer of care", "definition": "Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.", "alias": [ "ReferralRequest TransferOfCare Request" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "w5", "map": "clinical.careprovision" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.identifier", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.identifier", "path": "ReferralRequest.identifier", "short": "Business identifier", "definition": "Business identifier that uniquely identifies the referral/care transfer request instance.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RF1-6 / RF1-11" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.definition", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.definition", "path": "ReferralRequest.definition", "short": "Instantiates protocol or definition", "definition": "A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.basedOn", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.basedOn", "path": "ReferralRequest.basedOn", "short": "Request fulfilled by this request", "definition": "Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.", "alias": [ "fulfills" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest" } ], "isModifier": false, "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.replaces", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.replaces", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.replaces", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.replaces", "path": "ReferralRequest.replaces", "short": "Request(s) replaced by this request", "definition": "Completed or terminated request(s) whose function is taken by this new request.", "comment": "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.", "requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.", "alias": [ "supersedes", "prior", "renewed order" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=RPLC].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.groupIdentifier", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.groupIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.groupIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.groupIdentifier", "path": "ReferralRequest.groupIdentifier", "short": "Composite request this is part of", "definition": "The business identifier of the logical \"grouping\" request/order that this referral is a part of.", "requirements": "Allows multiple orders to be collected as part of a single requisition.", "alias": [ "grouperId", "requisition" ], "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isModifier": false, "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.status", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.status", "path": "ReferralRequest.status", "short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown", "definition": "The status of the authorization/intention reflected by the referral request record.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "requirements": "Workflow status is handled by the Task resource.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferralRequestStatus" } ], "strength": "required", "description": "The status of the referral.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-status" } }, "mapping": [ { "identity": "v2", "map": "RF1-1" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.intent", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.intent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.intent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.intent", "path": "ReferralRequest.intent", "short": "proposal | plan | order", "definition": "Distinguishes the \"level\" of authorization/demand implicit in this request.", "requirements": "The same resource structure is used when capturing proposals/recommendations, plans and actual requests.", "alias": [ "category" ], "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferralCategory" } ], "strength": "required", "description": "Codes identifying the stage lifecycle stage of a request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-intent" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.type", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.type", "path": "ReferralRequest.type", "short": "Referral/Transition of care request type", "definition": "An indication of the type of referral (or where applicable the type of transfer of care) request.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferralType" } ], "strength": "example", "description": "Codes for types of referral; e.g. consult, transfer, temporary transfer.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/referral-type" } }, "mapping": [ { "identity": "v2", "map": "RF1-10" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.priority", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.priority", "path": "ReferralRequest.priority", "short": "Urgency of referral / transfer of care request", "definition": "An indication of the urgency of referral (or where applicable the type of transfer of care) request.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferralPriority" } ], "strength": "required", "description": "Codes indicating the relative priority of the referral.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "v2", "map": "RF1-2" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.serviceRequested", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.serviceRequested", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.serviceRequested", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.serviceRequested", "path": "ReferralRequest.serviceRequested", "short": "Actions requested as part of the referral", "definition": "The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestedService" } ], "strength": "example", "description": "Codes indicating the types of services that might be requested as part of a referral.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, "mapping": [ { "identity": "v2", "map": "PR1-3 / OBR-4" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.subject", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.subject", "path": "ReferralRequest.subject", "short": "Patient referred to care or transfer", "definition": "The patient who is the subject of a referral or transfer of care request.", "comment": "Referral of family, group or community is to be catered for by profiles.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.context", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.context", "path": "ReferralRequest.context", "short": "Originating encounter", "definition": "The encounter at which the request for referral or transfer of care is initiated.", "alias": [ "encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PV1-19" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.occurrenceX", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.occurrenceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.occurrenceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.occurrence[x]", "path": "ReferralRequest.occurrence[x]", "short": "When the service(s) requested in the referral should occur", "definition": "The period of time within which the services identified in the referral/transfer of care is specified or required to occur.", "comment": "When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.", "requirements": "Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates (\"start\" and \"end\" values).", "alias": [ "timing" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBR-7/OBR-8" }, { "identity": "w5", "map": "when.planned" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.authoredOn", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.authoredOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.authoredOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.authoredOn", "path": "ReferralRequest.authoredOn", "short": "Date of creation/activation", "definition": "Date/DateTime of creation for draft requests and date of activation for active requests.", "alias": [ "createdOn" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RF1-7 / RF1-9?" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.requester", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.requester", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.requester", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.requester", "path": "ReferralRequest.requester", "short": "Who/what is requesting service", "definition": "The individual who initiated the request and has responsibility for its activation.", "alias": [ "author" ], "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "rfr-1", "severity": "error", "human": "onBehalfOf can only be specified if agent is practitioner or device", "expression": "(agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()", "xpath": "contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.requester.agent", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.requester.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.requester.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.requester.agent", "path": "ReferralRequest.requester.agent", "short": "Individual making the request", "definition": "The device, practitioner, etc. who initiated the request.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".player" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.requester.onBehalfOf", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.requester.onBehalfOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.requester.onBehalfOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.requester.onBehalfOf", "path": "ReferralRequest.requester.onBehalfOf", "short": "Organization agent is acting for", "definition": "The organization the device or practitioner was acting on behalf of.", "requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "condition": [ "rfr-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.specialty", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.specialty", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.specialty", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.specialty", "path": "ReferralRequest.specialty", "short": "The clinical specialty (discipline) that the referral is requested for", "definition": "Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isModifier": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferralSpecialty" } ], "strength": "example", "description": "Codes indicating the types of capability the referred to service provider must have.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/practitioner-specialty" } }, "mapping": [ { "identity": "v2", "map": "RF1-3" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.recipient", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.recipient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.recipient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.recipient", "path": "ReferralRequest.recipient", "short": "Receiver of referral / transfer of care request", "definition": "The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.", "comment": "There will be a primary receiver. But the request can be received by any number of \"copied to\" providers or organizations.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Practitioner: PRD-2/PRD-7 where PRD-3 = RT; Organization: PRD-10 where PRD-3 = RT" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.reasonCode", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.reasonCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.reasonCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.reasonCode", "path": "ReferralRequest.reasonCode", "short": "Reason for referral / transfer of care request", "definition": "Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferralReason" } ], "strength": "example", "description": "Codes indicating why the referral is being requested.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } }, "mapping": [ { "identity": "v2", "map": "RF1-10" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.reasonReference", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.reasonReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.reasonReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.reasonReference", "path": "ReferralRequest.reasonReference", "short": "Why is service needed?", "definition": "Indicates another resource whose existence justifies this request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.description", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.description", "path": "ReferralRequest.description", "short": "A textual description of the referral", "definition": "The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.supportingInfo", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.supportingInfo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.supportingInfo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.supportingInfo", "path": "ReferralRequest.supportingInfo", "short": "Additonal information to support referral or transfer of care request", "definition": "Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isModifier": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.note", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.note", "path": "ReferralRequest.note", "short": "Comments made about referral request", "definition": "Comments made about the referral request by any of the participants.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ReferralRequest.relevantHistory", "resource": { "resourceType": "DataElement", "id": "ReferralRequest.relevantHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ReferralRequest.relevantHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ReferralRequest.relevantHistory", "path": "ReferralRequest.relevantHistory", "short": "Key events in history of request", "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 element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.", "alias": [ "eventHistory" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account", "resource": { "resourceType": "DataElement", "id": "Account", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account", "path": "Account", "short": "Tracks balance, charges, for patient or cost center", "definition": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.", "alias": [ "Cost center", "Record" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Account" }, { "identity": "w5", "map": "financial.support" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.identifier", "resource": { "resourceType": "DataElement", "id": "Account.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.identifier", "path": "Account.identifier", "short": "Account number", "definition": "Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.status", "resource": { "resourceType": "DataElement", "id": "Account.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.status", "path": "Account.status", "short": "active | inactive | entered-in-error", "definition": "Indicates whether the account is presently used/usable or not.", "comment": "This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AccountStatus" } ], "strength": "required", "description": "Indicates whether the account is available to be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/account-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.type", "resource": { "resourceType": "DataElement", "id": "Account.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.type", "path": "Account.type", "short": "E.g. patient, expense, depreciation", "definition": "Categorizes the account for reporting and searching purposes.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AccountType" } ], "strength": "example", "description": "The usage type of this account, permits categorization of accounts.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/account-type" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.name", "resource": { "resourceType": "DataElement", "id": "Account.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.name", "path": "Account.name", "short": "Human-readable label", "definition": "Name used for the account when displaying it to humans in reports, etc.", "alias": [ "Title" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".title" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.subject", "resource": { "resourceType": "DataElement", "id": "Account.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.subject", "path": "Account.subject", "short": "What is account tied to?", "definition": "Identifies the patient, device, practitioner, location or other object the account is associated with.", "comment": "Accounts can be applied to non patients for tracking other non patient related activities, such as group services (patients not tracked, and costs charged to another body), or may not be allocated.", "alias": [ "target" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".subject" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.period", "resource": { "resourceType": "DataElement", "id": "Account.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.period", "path": "Account.period", "short": "Transaction window", "definition": "Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.", "comment": "It is possible for transactions relevant to a coverage period to be posted to the account before or after the coverage period, however the services that are being charged for must be within this period.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".coverage.insurancePolicy.effectiveTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.active", "resource": { "resourceType": "DataElement", "id": "Account.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.active", "path": "Account.active", "short": "Time window that transactions may be posted to this account", "definition": "Indicates the period of time over which the account is allowed to have transactions posted to it.\nThis period may be different to the coveragePeriod which is the duration of time that services may occur.", "requirements": "Accounts are able to be active only during a specific period, and the dates to which charges should be able to be applied.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.balance", "resource": { "resourceType": "DataElement", "id": "Account.balance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.balance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.balance", "path": "Account.balance", "short": "How much is in account?", "definition": "Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "rim", "map": ".balanceAmt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.coverage", "resource": { "resourceType": "DataElement", "id": "Account.coverage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.coverage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.coverage", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Coverage" } ], "path": "Account.coverage", "short": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account", "definition": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.", "comment": "Typically this may be some form of insurance, internal charges, or self-pay.\n\nLocal or jurisdicational business rules may determine which coverage covers which types of billable items charged to the account, and in which order.\nWhere the order is important, a local/jurisdicational extension may be defined to specify the order for the type of charge.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".coverage" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.coverage.coverage", "resource": { "resourceType": "DataElement", "id": "Account.coverage.coverage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.coverage.coverage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.coverage.coverage", "path": "Account.coverage.coverage", "short": "The party(s) that are responsible for covering the payment of this account", "definition": "The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).\n\nA coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Coverage" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".coverage.insurancePolicy.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.coverage.priority", "resource": { "resourceType": "DataElement", "id": "Account.coverage.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.coverage.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.coverage.priority", "path": "Account.coverage.priority", "short": "The priority of the coverage in the context of this account", "definition": "The priority of the coverage in the context of this account.", "comment": "It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).", "alias": [ "coordination of benefit priority" ], "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".coverage.sequenceNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.owner", "resource": { "resourceType": "DataElement", "id": "Account.owner", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.owner", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.owner", "path": "Account.owner", "short": "Who is responsible?", "definition": "Indicates the organization, department, etc. with responsibility for the account.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".holder" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.description", "resource": { "resourceType": "DataElement", "id": "Account.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.description", "path": "Account.description", "short": "Explanation of purpose/use", "definition": "Provides additional information about what the account tracks and how it is used.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".subjectOf.observationEvent[code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.guarantor", "resource": { "resourceType": "DataElement", "id": "Account.guarantor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.guarantor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.guarantor", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Guarantor" } ], "path": "Account.guarantor", "short": "Responsible for the account", "definition": "Parties financially responsible for the account.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".holder.guarantorRole" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.guarantor.party", "resource": { "resourceType": "DataElement", "id": "Account.guarantor.party", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.guarantor.party", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.guarantor.party", "path": "Account.guarantor.party", "short": "Responsible entity", "definition": "The entity who is responsible.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": ".holder.guarantorRole[guarantorPerson|guarantorOrganization]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.guarantor.onHold", "resource": { "resourceType": "DataElement", "id": "Account.guarantor.onHold", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.guarantor.onHold", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.guarantor.onHold", "path": "Account.guarantor.onHold", "short": "Credit or other hold applied", "definition": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "mapping": [ { "identity": "rim", "map": ".holder.guarantorRole.statusCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Account.guarantor.period", "resource": { "resourceType": "DataElement", "id": "Account.guarantor.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Account.guarantor.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Account.guarantor.period", "path": "Account.guarantor.period", "short": "Guarrantee account during", "definition": "The timeframe during which the guarantor accepts responsibility for the account.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".holder.guarantorRole.effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest", "resource": { "resourceType": "DataElement", "id": "DocumentManifest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest", "path": "DocumentManifest", "short": "A list that defines a set of documents", "definition": "A collection of documents compiled for a purpose together with metadata that applies to the collection.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[classCode=FOLDER, moodCode=EVN]" }, { "identity": "w5", "map": "infrastructure.documents" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.masterIdentifier", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.masterIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.masterIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.masterIdentifier", "path": "DocumentManifest.masterIdentifier", "short": "Unique Identifier for the set of documents", "definition": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "id [need a list semantic to indicate order matters]" }, { "identity": "xds", "map": "SubmissionSet.uniqueId" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.identifier", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.identifier", "path": "DocumentManifest.identifier", "short": "Other identifiers for the manifest", "definition": "Other identifiers associated with the document manifest, including version independent identifiers.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-16-Unique Document File Name?" }, { "identity": "rim", "map": ".id / .setId" }, { "identity": "xds", "map": "SubmissionSet.entryUUID" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.status", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.status", "path": "DocumentManifest.status", "short": "current | superseded | entered-in-error", "definition": "The status of this document manifest.", "comment": "This element is labeled as a modifier because the status contains the codes that mark the manifest as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentReferenceStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The status of the document reference.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/document-reference-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode" }, { "identity": "xds", "map": "SubmissionSet status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.type", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.type", "path": "DocumentManifest.type", "short": "Kind of document set", "definition": "Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80Type" } ], "strength": "preferred", "description": "Precise type of clinical document.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "xds", "map": "SubmissionSet.contentTypeCode" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.subject", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.subject", "path": "DocumentManifest.subject", "short": "The subject of the set of documents", "definition": "Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "xds", "map": "SubmissionSet.patientId" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.created", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.created", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.created", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.created", "path": "DocumentManifest.created", "short": "When this document manifest created", "definition": "When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).", "comment": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "xds", "map": "SubmissionSet.submissionTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.author", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.author", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.author", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.author", "path": "DocumentManifest.author", "short": "Who and/or what authored the manifest", "definition": "Identifies who is responsible for creating the manifest, and adding documents to it.", "comment": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "xds", "map": "SubmissionSet.author" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.recipient", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.recipient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.recipient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.recipient", "path": "DocumentManifest.recipient", "short": "Intended to get notified about this set of documents", "definition": "A patient, practitioner, or organization for which this set of documents is intended.", "comment": "How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=IRCP].role" }, { "identity": "xds", "map": "SubmissionSet.intendedRecipient" }, { "identity": "w5", "map": "who.cause" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.source", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.source", "path": "DocumentManifest.source", "short": "The source system/application/software", "definition": "Identifies the source system, application, or software that produced the document manifest.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PFM].time" }, { "identity": "xds", "map": "SubmissionSet.sourceId" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.description", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.description", "path": "DocumentManifest.description", "short": "Human-readable description (title)", "definition": "Human-readable description of the source document. This is sometimes known as the \"title\".", "comment": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").", "requirements": "Helps humans to assess whether the document is of interest.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".title" }, { "identity": "xds", "map": "SubmissionSet.title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.content", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.content", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.content", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.content", "path": "DocumentManifest.content", "short": "The items included", "definition": "The list of Documents included in the manifest.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.content.pX", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.content.pX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.content.pX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.content.p[x]", "path": "DocumentManifest.content.p[x]", "short": "Contents of this set of documents", "definition": "The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.", "comment": "The intended focus of the DocumentManifest is for the reference to target either DocumentReference or Media Resources, and most implementation guides will restrict to these resources. The reference is to \"Any\" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.", "min": 1, "max": "1", "type": [ { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" }, { "identity": "xds", "map": "SubmissionSet DocumentEntry(s)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.related", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.related", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.related", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.related", "path": "DocumentManifest.related", "short": "Related things", "definition": "Related identifiers or resources associated with the DocumentManifest.", "comment": "May be identifiers or resources that caused the DocumentManifest to be created.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.related.identifier", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.related.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.related.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.related.identifier", "path": "DocumentManifest.related.identifier", "short": "Identifiers of things that are related", "definition": "Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.", "comment": "If both identifier and ref elements are present they shall refer to the same thing.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentManifest.related.ref", "resource": { "resourceType": "DataElement", "id": "DocumentManifest.related.ref", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentManifest.related.ref", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentManifest.related.ref", "path": "DocumentManifest.related.ref", "short": "Related Resource", "definition": "Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etc.", "comment": "If both identifier and ref elements are present they shall refer to the same thing.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition", "resource": { "resourceType": "DataElement", "id": "MessageDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition", "path": "MessageDefinition", "short": "A resource that defines a type of message that can be exchanged between systems", "definition": "Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.", "comment": "This would be a MIF-level artifact.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "infrastructure.exchange" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.url", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.url", "path": "MessageDefinition.url", "short": "Logical URI to reference this message definition (globally unique)", "definition": "An absolute URI that is used to identify this message definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the message definition to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.identifier", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.identifier", "path": "MessageDefinition.identifier", "short": "Additional identifier for the message definition", "definition": "A formal identifier that is used to identify this message 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, e.g., to identify this message 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": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.version", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.version", "path": "MessageDefinition.version", "short": "Business version of the message definition", "definition": "The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the message definition with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.name", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.name", "path": "MessageDefinition.name", "short": "Name for this message definition (computer friendly)", "definition": "A natural language name identifying the message 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.title", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.title", "path": "MessageDefinition.title", "short": "Name for this message definition (human friendly)", "definition": "A short, descriptive, user-friendly title for the message definition.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.status", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.status", "path": "MessageDefinition.status", "short": "draft | active | retired | unknown", "definition": "The status of this message definition. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of message definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired message definition without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.experimental", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.experimental", "path": "MessageDefinition.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of message definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental message definition in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.date", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.date", "path": "MessageDefinition.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the message definition was published. The date must change if and 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 message 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 message 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": 1, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.publisher", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.publisher", "path": "MessageDefinition.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the message definition.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message 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 message definition. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the message definition. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.contact", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.contact", "path": "MessageDefinition.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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.description", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.description", "path": "MessageDefinition.description", "short": "Natural language description of the message definition", "definition": "A free text natural language description of the message definition from a consumer's perspective.", "comment": "This description can be used to capture details such as why the message 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 message 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.useContext", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.useContext", "path": "MessageDefinition.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate message definition instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.jurisdiction", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.jurisdiction", "path": "MessageDefinition.jurisdiction", "short": "Intended jurisdiction for message definition (if applicable)", "definition": "A legal or geographic region in which the message definition is intended to be used.", "comment": "It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.purpose", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.purpose", "path": "MessageDefinition.purpose", "short": "Why this message definition is defined", "definition": "Explaination of why this message definition is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the message 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 message definition.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.copyright", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.copyright", "path": "MessageDefinition.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.base", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.base", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.base", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.base", "path": "MessageDefinition.base", "short": "Definition this one is based on", "definition": "The MessageDefinition that is the basis for the contents of this resource.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MessageDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.parent", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.parent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.parent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.parent", "path": "MessageDefinition.parent", "short": "Protocol/workflow this is part of", "definition": "Identifies a protocol or workflow that this MessageDefinition represents a step in.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.replaces", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.replaces", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.replaces", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.replaces", "path": "MessageDefinition.replaces", "short": "Takes the place of", "definition": "A MessageDefinition that is superseded by this definition.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MessageDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.event", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.event", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.event", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.event", "path": "MessageDefinition.event", "short": "Event type", "definition": "A coded identifier of a supported messaging event.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MessageEvent" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "example", "description": "One of the message events defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/message-events" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.category", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.category", "path": "MessageDefinition.category", "short": "Consequence | Currency | Notification", "definition": "The impact of the content of the message.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MessageSignificanceCategory" } ], "strength": "required", "description": "The impact of the content of a message.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/message-significance-category" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.focus", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.focus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.focus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.focus", "path": "MessageDefinition.focus", "short": "Resource(s) that are the subject of the event", "definition": "Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "md-1", "severity": "error", "human": "Max must be postive int or *", "expression": "max='*' or (max.toInteger() > 0)", "xpath": "f:max/@value='*' or number(f:max/@value) > 0" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.code", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.focus.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.focus.code", "path": "MessageDefinition.focus.code", "short": "Type of resource", "definition": "The kind of resource that must be the focus for this message.", "comment": "Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.profile", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.focus.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.focus.profile", "path": "MessageDefinition.focus.profile", "short": "Profile that must be adhered to by focus", "definition": "A profile that reflects constraints for the focal resource (and potentially for related resources).", "comment": "This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted.", "requirements": "This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.min", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.focus.min", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.min", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.focus.min", "path": "MessageDefinition.focus.min", "short": "Minimum number of focuses of this type", "definition": "Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "defaultValueUnsignedInt": 0 } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.max", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.focus.max", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.focus.max", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.focus.max", "path": "MessageDefinition.focus.max", "short": "Maximum number of focuses of this type", "definition": "Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "md-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.responseRequired", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.responseRequired", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.responseRequired", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.responseRequired", "path": "MessageDefinition.responseRequired", "short": "Is a response required?", "definition": "Indicates whether a response is required for this message.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.allowedResponse", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.allowedResponse", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.allowedResponse", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.allowedResponse", "path": "MessageDefinition.allowedResponse", "short": "Responses to this message", "definition": "Indicates what types of messages may be sent as an application-level response to this message.", "comment": "This indicates an application level response to \"close\" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.allowedResponse.message", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.allowedResponse.message", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.allowedResponse.message", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.allowedResponse.message", "path": "MessageDefinition.allowedResponse.message", "short": "Reference to allowed message definition response", "definition": "A reference to the message definition that must be adhered to by this supported response.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MessageDefinition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageDefinition.allowedResponse.situation", "resource": { "resourceType": "DataElement", "id": "MessageDefinition.allowedResponse.situation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageDefinition.allowedResponse.situation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageDefinition.allowedResponse.situation", "path": "MessageDefinition.allowedResponse.situation", "short": "When should this response be used", "definition": "Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal", "resource": { "resourceType": "DataElement", "id": "Goal", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal", "path": "Goal", "short": "Describes the intended objective(s) for a patient, group or organization", "definition": "Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.", "comment": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "GOL.1" }, { "identity": "rim", "map": ".outboundRelationship[typeCode<=OBJ]." }, { "identity": "w5", "map": "clinical.careprovision" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.identifier", "resource": { "resourceType": "DataElement", "id": "Goal.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.identifier", "path": "Goal.identifier", "short": "External Ids for this goal", "definition": "This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "requirements": "Need to allow connection to a wider workflow.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.status", "resource": { "resourceType": "DataElement", "id": "Goal.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.status", "path": "Goal.status", "short": "proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected", "definition": "Indicates whether the goal has been reached and is still considered relevant.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "requirements": "Allows measuring outcome and whether goal needs to be further tracked.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalStatus" } ], "strength": "required", "description": "Indicates whether the goal has been met and is still being targeted", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/goal-status" } }, "mapping": [ { "identity": "v2", "map": "GOL-18-goal life cycle status" }, { "identity": "rim", "map": ".statusCode in-progress = active (classCode = OBJ) achieved = complete sustaining = active (classCode=OBJC) cancelled = aborted" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.category", "resource": { "resourceType": "DataElement", "id": "Goal.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.category", "path": "Goal.category", "short": "E.g. Treatment, dietary, behavioral, etc.", "definition": "Indicates a category the goal falls within.", "requirements": "Allows goals to be filtered and sorted.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalCategory" } ], "strength": "example", "description": "Codes for grouping and sorting goals", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/goal-category" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.priority", "resource": { "resourceType": "DataElement", "id": "Goal.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.priority", "path": "Goal.priority", "short": "high-priority | medium-priority | low-priority", "definition": "Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.", "comment": "Extensions are available to track priorities as established by each participant (i.e. Priority from the patient's perspective, different practitioners' perspectives, family member's perspectives)\r\rThe ordinal extension on Coding can be used to convey a numerically comparable ranking to priority. (Keep in mind that different coding systems may use a \"low value=important\".", "requirements": "Used for sorting and presenting goals.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalPriority" } ], "strength": "preferred", "description": "The level of importance associated with a goal", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/goal-priority" } }, "mapping": [ { "identity": "rim", "map": ".priorityCode" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.description", "resource": { "resourceType": "DataElement", "id": "Goal.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.description", "path": "Goal.description", "short": "Code or text describing goal", "definition": "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".", "comment": "If no code is available, use CodeableConcept.text.", "requirements": "Without a description of what's trying to be achieved, element has no purpose.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalDescription" } ], "strength": "example", "description": "Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } }, "mapping": [ { "identity": "v2", "map": "GOL-3.2-goal ID.text" }, { "identity": "rim", "map": ".text" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.subject", "resource": { "resourceType": "DataElement", "id": "Goal.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.subject", "path": "Goal.subject", "short": "Who this goal is intended for", "definition": "Identifies the patient, group or organization for whom the goal is being established.", "requirements": "Subject is optional to support annonymized reporting.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3-patient ID list" }, { "identity": "rim", "map": ".participation[typeCode=PAT].role[classCode=PAT]" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.startX", "resource": { "resourceType": "DataElement", "id": "Goal.startX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.startX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.start[x]", "path": "Goal.start[x]", "short": "When goal pursuit begins", "definition": "The date or event after which the goal should begin being pursued.", "requirements": "Goals can be established prior to there being an intention to start pursuing them; e.g. Goals for post-surgical recovery established prior to surgery.", "min": 0, "max": "1", "type": [ { "code": "date" }, { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalStartEvent" } ], "strength": "example", "description": "Codes describing events that can trigger the initiation of a goal", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/goal-start-event" } }, "mapping": [ { "identity": "w5", "map": "when.planned" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.target", "resource": { "resourceType": "DataElement", "id": "Goal.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.target", "path": "Goal.target", "short": "Target outcome for the goal", "definition": "Indicates what should be done by when.", "requirements": "Allows the progress of the goal to be monitored against an observation or due date.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "condition": [ "gol-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "gol-1", "severity": "error", "human": "Goal.target.measure is required if Goal.target.detail is populated", "expression": "(detail.exists() and measure.exists()) or detail.exists().not()", "xpath": "(exists(f:*[starts-with(local-name(.), 'detail')]) and exists(f:measure)) or not(exists(f:*[starts-with(local-name(.), 'detail')]))" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.target.measure", "resource": { "resourceType": "DataElement", "id": "Goal.target.measure", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.target.measure", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.target.measure", "path": "Goal.target.measure", "short": "The parameter whose value is being tracked", "definition": "The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "gol-1" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalTargetMeasure" } ], "strength": "example", "description": "Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-codes" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.target.detailX", "resource": { "resourceType": "DataElement", "id": "Goal.target.detailX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.target.detailX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.target.detail[x]", "path": "Goal.target.detail[x]", "short": "The target value to be achieved", "definition": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", "min": 0, "max": "1", "type": [ { "code": "Quantity" }, { "code": "Range" }, { "code": "CodeableConcept" } ], "condition": [ "gol-1" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalTargetDetail" } ], "strength": "example", "description": "Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal." } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.target.dueX", "resource": { "resourceType": "DataElement", "id": "Goal.target.dueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.target.dueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.target.due[x]", "path": "Goal.target.due[x]", "short": "Reach goal on or before", "definition": "Indicates either the date or the duration after start by which the goal should be met.", "requirements": "Identifies when the goal should be evaluated.", "min": 0, "max": "1", "type": [ { "code": "date" }, { "code": "Duration" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.statusDate", "resource": { "resourceType": "DataElement", "id": "Goal.statusDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.statusDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.statusDate", "path": "Goal.statusDate", "short": "When goal status took effect", "definition": "Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.", "comment": "To see the date for past statuses, query history.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.statusReason", "resource": { "resourceType": "DataElement", "id": "Goal.statusReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.statusReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.statusReason", "path": "Goal.statusReason", "short": "Reason for current status", "definition": "Captures the reason for the current status.", "comment": "This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.expressedBy", "resource": { "resourceType": "DataElement", "id": "Goal.expressedBy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.expressedBy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.expressedBy", "path": "Goal.expressedBy", "short": "Who's responsible for creating Goal?", "definition": "Indicates whose goal this is - patient goal, practitioner goal, etc.", "comment": "This is the individual reponsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.).", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.addresses", "resource": { "resourceType": "DataElement", "id": "Goal.addresses", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.addresses", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.addresses", "path": "Goal.addresses", "short": "Issues addressed by this goal", "definition": "The identified conditions and other health record elements that are intended to be addressed by the goal.", "requirements": "Allows specific goals to explicitly linked to the concerns they're dealing with - makes the goal more understandable.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RiskAssessment" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.note", "resource": { "resourceType": "DataElement", "id": "Goal.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.note", "path": "Goal.note", "short": "Comments about the goal", "definition": "Any comments related to the goal.", "comment": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.", "requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "v2", "map": "GOL-16-goal evaluation + NTE?" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.outcomeCode", "resource": { "resourceType": "DataElement", "id": "Goal.outcomeCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.outcomeCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.outcomeCode", "path": "Goal.outcomeCode", "short": "What result was achieved regarding the goal?", "definition": "Identifies the change (or lack of change) at the point when the status of the goal is assessed.", "comment": "Note that this should not duplicate the goal status.", "requirements": "Outcome tracking is a key aspect of care planning.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalOutcome" } ], "strength": "example", "description": "The result of the goal; e.g. \"25% increase in shoulder mobility\", \"Anxiety reduced to moderate levels\". \"15 kg weight loss sustained over 6 months\"", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Goal.outcomeReference", "resource": { "resourceType": "DataElement", "id": "Goal.outcomeReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Goal.outcomeReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Goal.outcomeReference", "path": "Goal.outcomeReference", "short": "Observation that resulted from goal", "definition": "Details of what's changed (or not changed).", "comment": "The goal outcome is independent of the outcome of the related activities. For example, if the Goal is to achieve a target body weight of 150 lb and a care plan activity is defined to diet, then the care plan’s activity outcome could be calories consumed whereas goal outcome is an observation for the actual body weight measured.", "requirements": "Outcome tracking is a key aspect of care planning.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint", "resource": { "resourceType": "DataElement", "id": "Endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint", "path": "Endpoint", "short": "The technical details of an endpoint that can be used for electronic services", "definition": "The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "infrastructure.exchange" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.identifier", "resource": { "resourceType": "DataElement", "id": "Endpoint.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.identifier", "path": "Endpoint.identifier", "short": "Identifies this endpoint across multiple systems", "definition": "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.status", "resource": { "resourceType": "DataElement", "id": "Endpoint.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.status", "path": "Endpoint.status", "short": "active | suspended | error | off | entered-in-error | test", "definition": "active | suspended | error | off | test.", "comment": "This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EndpointStatus" } ], "strength": "required", "description": "The status of the endpoint", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/endpoint-status" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.connectionType", "resource": { "resourceType": "DataElement", "id": "Endpoint.connectionType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.connectionType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.connectionType", "path": "Endpoint.connectionType", "short": "Protocol/Profile/Standard to be used with this endpoint connection", "definition": "A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).", "comment": "For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "endpoint-contype" } ], "strength": "extensible", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/endpoint-connection-type" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.name", "resource": { "resourceType": "DataElement", "id": "Endpoint.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.name", "path": "Endpoint.name", "short": "A name that this endpoint can be identified by", "definition": "A friendly name that this endpoint can be referred to with.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.managingOrganization", "resource": { "resourceType": "DataElement", "id": "Endpoint.managingOrganization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.managingOrganization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.managingOrganization", "path": "Endpoint.managingOrganization", "short": "Organization that manages this endpoint (may not be the organization that exposes the endpoint)", "definition": "The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).", "comment": "This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an aplicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.contact", "resource": { "resourceType": "DataElement", "id": "Endpoint.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.contact", "path": "Endpoint.contact", "short": "Contact details for source (e.g. troubleshooting)", "definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.", "min": 0, "max": "*", "type": [ { "code": "ContactPoint" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.period", "resource": { "resourceType": "DataElement", "id": "Endpoint.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.period", "path": "Endpoint.period", "short": "Interval the endpoint is expected to be operational", "definition": "The interval during which the endpoint is expected to be operational.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.payloadType", "resource": { "resourceType": "DataElement", "id": "Endpoint.payloadType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.payloadType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.payloadType", "path": "Endpoint.payloadType", "short": "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)", "definition": "The payload type describes the acceptable content that can be communicated on the endpoint.", "comment": "The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.", "min": 1, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PayloadType" } ], "strength": "example", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/endpoint-payload-type" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.payloadMimeType", "resource": { "resourceType": "DataElement", "id": "Endpoint.payloadMimeType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.payloadMimeType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.payloadMimeType", "path": "Endpoint.payloadMimeType", "short": "Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)", "definition": "The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).", "comment": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" }, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.address", "resource": { "resourceType": "DataElement", "id": "Endpoint.address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.address", "path": "Endpoint.address", "short": "The technical base address for connecting to this endpoint", "definition": "The uri that describes the actual end-point to connect to.", "comment": "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs)\n\nThis address will be to the service base, without any parameters, or sub-services or resources tacked on.\n\nE.g. for a WADO-RS endpoint, the url should be \"https://pacs.hospital.org/wado-rs\"\n\nand not \"https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...\".", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Endpoint.header", "resource": { "resourceType": "DataElement", "id": "Endpoint.header", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Endpoint.header", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Endpoint.header", "path": "Endpoint.header", "short": "Usage depends on the channel type", "definition": "Additional headers / information to send as part of the notification.", "comment": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest", "path": "EnrollmentRequest", "short": "Enrollment request", "definition": "This resource provides the insurance enrollment details to the insurer regarding a specified coverage.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "w5", "map": "financial.support" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.identifier", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.identifier", "path": "EnrollmentRequest.identifier", "short": "Business Identifier", "definition": "The Response business identifier.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.status", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.status", "path": "EnrollmentRequest.status", "short": "active | cancelled | draft | entered-in-error", "definition": "The status of the resource instance.", "comment": "This element is labeled as a modifier because the status contains codes that mark the request as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EnrollmentRequestStatus" } ], "strength": "required", "description": "A code specifying the state of the resource instance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/fm-status" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.created", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.created", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.created", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.created", "path": "EnrollmentRequest.created", "short": "Creation date", "definition": "The date when this resource was created.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.insurer", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.insurer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.insurer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.insurer", "path": "EnrollmentRequest.insurer", "short": "Target", "definition": "The Insurer who is target of the request.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.provider", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.provider", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.provider", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.provider", "path": "EnrollmentRequest.provider", "short": "Responsible practitioner", "definition": "The practitioner who is responsible for the services rendered to the patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "mapping": [ { "identity": "cdanetv4", "map": "B01" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.organization", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.organization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.organization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.organization", "path": "EnrollmentRequest.organization", "short": "Responsible organization", "definition": "The organization which is responsible for the services rendered to the patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.subject", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.subject", "path": "EnrollmentRequest.subject", "short": "The subject of the Products and Services", "definition": "Patient Resource.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "mapping": [ { "identity": "cdanetv4", "map": "C06,C07,C08, C05, C04" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EnrollmentRequest.coverage", "resource": { "resourceType": "DataElement", "id": "EnrollmentRequest.coverage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EnrollmentRequest.coverage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EnrollmentRequest.coverage", "path": "EnrollmentRequest.coverage", "short": "Insurance information", "definition": "Reference to the program or plan identification, underwriter or payor.", "requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Coverage" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent", "resource": { "resourceType": "DataElement", "id": "Consent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent", "path": "Consent", "short": "A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time", "definition": "A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.", "comment": "Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "ppc-1", "severity": "error", "human": "Either a Policy or PolicyRule", "expression": "policy.exists() or policyRule.exists()", "xpath": "exists(f:policy) or exists(f:policyRule)" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "FinancialConsent" }, { "identity": "w5", "map": "infrastructure.information" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.identifier", "resource": { "resourceType": "DataElement", "id": "Consent.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.identifier", "path": "Consent.identifier", "short": "Identifier for this record (external references)", "definition": "Unique identifier for this copy of the Consent Statement.", "comment": "This identifier is identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "example": [ { "label": "General", "valueIdentifier": { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.status", "resource": { "resourceType": "DataElement", "id": "Consent.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.status", "path": "Consent.status", "short": "draft | proposed | active | rejected | inactive | entered-in-error", "definition": "Indicates the current state of this consent.", "comment": "This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.", "requirements": "The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentState" } ], "strength": "required", "description": "Indicates the state of the consent", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-state-codes" } }, "mapping": [ { "identity": "v2", "map": "HL7 Table 0498 - Consent Status" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.category", "resource": { "resourceType": "DataElement", "id": "Consent.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.category", "path": "Consent.category", "short": "Classification of the consent statement - for indexing/retrieval", "definition": "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentCategory" } ], "strength": "example", "description": "A classification of the type of consents found in a consent statement", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-category" } }, "mapping": [ { "identity": "rim", "map": "CNTRCT" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.patient", "resource": { "resourceType": "DataElement", "id": "Consent.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.patient", "path": "Consent.patient", "short": "Who the consent applies to", "definition": "The patient/healthcare consumer to whom this consent applies.", "comment": "Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Role" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.period", "resource": { "resourceType": "DataElement", "id": "Consent.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.period", "path": "Consent.period", "short": "Period that this consent applies", "definition": "Relevant time or time-period when this Consent is applicable.", "comment": "This can be a subset of the period of the original statement.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "meaningWhenMissing": "all date ranges included", "isSummary": true, "mapping": [ { "identity": "rim", "map": "FinancialConsent activityTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.dateTime", "resource": { "resourceType": "DataElement", "id": "Consent.dateTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.dateTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.dateTime", "path": "Consent.dateTime", "short": "When this Consent was created or indexed", "definition": "When this Consent was issued / created / indexed.", "comment": "This is not the time of the original consent, but the time that this statement was made or derived.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "FinancialConsent effectiveTime" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.consentingParty", "resource": { "resourceType": "DataElement", "id": "Consent.consentingParty", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.consentingParty", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.consentingParty", "path": "Consent.consentingParty", "short": "Who is agreeing to the policy and exceptions", "definition": "Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.", "comment": "Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.", "alias": [ "consentor" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.actor", "resource": { "resourceType": "DataElement", "id": "Consent.actor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.actor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.actor", "path": "Consent.actor", "short": "Who|what controlled by this consent (or group, by role)", "definition": "Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "meaningWhenMissing": "There is no specific actor associated with the consent", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.actor.role", "resource": { "resourceType": "DataElement", "id": "Consent.actor.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.actor.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.actor.role", "path": "Consent.actor.role", "short": "How the actor is involved", "definition": "How the individual is involved in the resources content that is described in the consent.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentActorRole" } ], "strength": "extensible", "description": "How an actor is involved in the consent considerations", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-role-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.actor.reference", "resource": { "resourceType": "DataElement", "id": "Consent.actor.reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.actor.reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.actor.reference", "path": "Consent.actor.reference", "short": "Resource for the actor (or group, by role)", "definition": "The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.action", "resource": { "resourceType": "DataElement", "id": "Consent.action", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.action", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.action", "path": "Consent.action", "short": "Actions controlled by this consent", "definition": "Actions controlled by this consent.", "comment": "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "meaningWhenMissing": "all actions", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentAction" } ], "strength": "example", "description": "Detailed codes for the consent action.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-action" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.organization", "resource": { "resourceType": "DataElement", "id": "Consent.organization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.organization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.organization", "path": "Consent.organization", "short": "Custodian of the consent", "definition": "The organization that manages the consent, and the framework within which it is executed.", "alias": [ "custodian" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.sourceX", "resource": { "resourceType": "DataElement", "id": "Consent.sourceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.sourceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.source[x]", "path": "Consent.source[x]", "short": "Source from which this consent is taken", "definition": "The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.", "comment": "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.", "min": 0, "max": "1", "type": [ { "code": "Attachment" }, { "code": "Identifier" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Consent" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Contract" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.policy", "resource": { "resourceType": "DataElement", "id": "Consent.policy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.policy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.policy", "path": "Consent.policy", "short": "Policies covered by this consent", "definition": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.policy.authority", "resource": { "resourceType": "DataElement", "id": "Consent.policy.authority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.policy.authority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.policy.authority", "path": "Consent.policy.authority", "short": "Enforcement source for policy", "definition": "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "condition": [ "ppc-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.policy.uri", "resource": { "resourceType": "DataElement", "id": "Consent.policy.uri", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.policy.uri", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.policy.uri", "path": "Consent.policy.uri", "short": "Specific policy covered by this consent", "definition": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.", "comment": "This element is for discoverability / documentation, and does not modify or qualify the policy rules.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "condition": [ "ppc-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.policyRule", "resource": { "resourceType": "DataElement", "id": "Consent.policyRule", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.policyRule", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.policyRule", "path": "Consent.policyRule", "short": "Policy that this consents to", "definition": "A referece to the specific computable policy.", "comment": "If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in the consent resource.", "requirements": "Might be a unique identifier of a policy set in XACML, or other rules engine.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "condition": [ "ppc-1" ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.securityLabel", "resource": { "resourceType": "DataElement", "id": "Consent.securityLabel", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.securityLabel", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.securityLabel", "path": "Consent.securityLabel", "short": "Security Labels that define affected resources", "definition": "A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.", "comment": "If the consent specifies a security label of \"R\" then it applies to all resources that are labeled \"R\" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?).", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.purpose", "resource": { "resourceType": "DataElement", "id": "Consent.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.purpose", "path": "Consent.purpose", "short": "Context of activities for which the agreement is made", "definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.", "comment": "This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies).", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PurposeOfUse" } ], "strength": "extensible", "description": "What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.dataPeriod", "resource": { "resourceType": "DataElement", "id": "Consent.dataPeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.dataPeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.dataPeriod", "path": "Consent.dataPeriod", "short": "Timeframe for data controlled by this consent", "definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this consent.", "comment": "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.data", "resource": { "resourceType": "DataElement", "id": "Consent.data", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.data", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.data", "path": "Consent.data", "short": "Data controlled by this consent", "definition": "The resources controlled by this consent, if specific resources are referenced.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "meaningWhenMissing": "all data", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.data.meaning", "resource": { "resourceType": "DataElement", "id": "Consent.data.meaning", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.data.meaning", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.data.meaning", "path": "Consent.data.meaning", "short": "instance | related | dependents | authoredby", "definition": "How the resource reference is interpreted when testing consent restrictions.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentDataMeaning" } ], "strength": "required", "description": "How a resource reference is interpreted when testing consent restrictions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.data.reference", "resource": { "resourceType": "DataElement", "id": "Consent.data.reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.data.reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.data.reference", "path": "Consent.data.reference", "short": "The actual data reference", "definition": "A reference to a specific resource that defines which resources are covered by this consent.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except", "resource": { "resourceType": "DataElement", "id": "Consent.except", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Except" } ], "path": "Consent.except", "short": "Additional rule - addition or removal of permissions", "definition": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.type", "resource": { "resourceType": "DataElement", "id": "Consent.except.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.type", "path": "Consent.except.type", "short": "deny | permit", "definition": "Action to take - permit or deny - when the exception conditions are met.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentExceptType" } ], "strength": "required", "description": "How an exception statement is applied, such as adding additional consent or removing consent", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-except-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.period", "resource": { "resourceType": "DataElement", "id": "Consent.except.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.period", "path": "Consent.except.period", "short": "Timeframe for this exception", "definition": "The timeframe in this exception is valid.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.actor", "resource": { "resourceType": "DataElement", "id": "Consent.except.actor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.actor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.actor", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ExceptActor" } ], "path": "Consent.except.actor", "short": "Who|what controlled by this exception (or group, by role)", "definition": "Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "meaningWhenMissing": "There is no specific actor associated with the exception", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.actor.role", "resource": { "resourceType": "DataElement", "id": "Consent.except.actor.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.actor.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.actor.role", "path": "Consent.except.actor.role", "short": "How the actor is involved", "definition": "How the individual is involved in the resources content that is described in the exception.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentActorRole" } ], "strength": "extensible", "description": "How an actor is involved in the consent considerations", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-role-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.actor.reference", "resource": { "resourceType": "DataElement", "id": "Consent.except.actor.reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.actor.reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.actor.reference", "path": "Consent.except.actor.reference", "short": "Resource for the actor (or group, by role)", "definition": "The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.action", "resource": { "resourceType": "DataElement", "id": "Consent.except.action", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.action", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.action", "path": "Consent.except.action", "short": "Actions controlled by this exception", "definition": "Actions controlled by this Exception.", "comment": "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "meaningWhenMissing": "all actions", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentAction" } ], "strength": "example", "description": "Detailed codes for the consent action.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-action" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.securityLabel", "resource": { "resourceType": "DataElement", "id": "Consent.except.securityLabel", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.securityLabel", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.securityLabel", "path": "Consent.except.securityLabel", "short": "Security Labels that define affected resources", "definition": "A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.", "comment": "If the consent specifies a security label of \"R\" then it applies to all resources that are labeled \"R\" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?).", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.purpose", "resource": { "resourceType": "DataElement", "id": "Consent.except.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.purpose", "path": "Consent.except.purpose", "short": "Context of activities covered by this exception", "definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.", "comment": "E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?).", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PurposeOfUse" } ], "strength": "extensible", "description": "What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.class", "resource": { "resourceType": "DataElement", "id": "Consent.except.class", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.class", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.class", "path": "Consent.except.class", "short": "e.g. Resource Type, Profile, or CDA etc", "definition": "The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.", "comment": "Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentContentClass" } ], "strength": "extensible", "description": "The class (type) of information a consent rule covers", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-content-class" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.code", "resource": { "resourceType": "DataElement", "id": "Consent.except.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.code", "path": "Consent.except.code", "short": "e.g. LOINC or SNOMED CT code, etc in the content", "definition": "If this code is found in an instance, then the exception applies.", "comment": "Typical use of this is a Document code with class = CDA.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentContentCode" } ], "strength": "example", "description": "If this code is found in an instance, then the exception applies", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-content-code" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.dataPeriod", "resource": { "resourceType": "DataElement", "id": "Consent.except.dataPeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.dataPeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.dataPeriod", "path": "Consent.except.dataPeriod", "short": "Timeframe for data controlled by this exception", "definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this exception.", "comment": "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.data", "resource": { "resourceType": "DataElement", "id": "Consent.except.data", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.data", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.data", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ExceptData" } ], "path": "Consent.except.data", "short": "Data controlled by this exception", "definition": "The resources controlled by this exception, if specific resources are referenced.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "meaningWhenMissing": "all data", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.data.meaning", "resource": { "resourceType": "DataElement", "id": "Consent.except.data.meaning", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.data.meaning", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.data.meaning", "path": "Consent.except.data.meaning", "short": "instance | related | dependents | authoredby", "definition": "How the resource reference is interpreted when testing consent restrictions.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConsentDataMeaning" } ], "strength": "required", "description": "How a resource reference is interpreted when testing consent restrictions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Consent.except.data.reference", "resource": { "resourceType": "DataElement", "id": "Consent.except.data.reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Consent.except.data.reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Consent.except.data.reference", "path": "Consent.except.data.reference", "short": "The actual data reference", "definition": "A reference to a specific resource that defines which resources are covered by this consent.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement", "path": "CapabilityStatement", "short": "A statement of system capabilities", "definition": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", "min": 1, "max": "1", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "cpb-8", "severity": "error", "human": "There can only be one REST declaration per mode.", "expression": "rest.select(mode).isDistinct()", "xpath": "count(f:rest)=count(distinct-values(f:rest/f:mode/@value))" }, { "key": "cpb-7", "severity": "error", "human": "The set of documents must be unique by the combination of profile and mode.", "expression": "document.select(profile.reference&mode).isDistinct()", "xpath": "count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value))" }, { "key": "cpb-15", "severity": "error", "human": "Capability Statements of kind 'instance' do not have implementation elements.", "expression": "implementation.empty() or kind != 'capability'", "xpath": "not(exists(f:implementation)) or (f:kind/@value != 'capability')" }, { "key": "cpb-3", "severity": "error", "human": "Messaging end-point is required (and is only permitted) when a statement is for an implementation.", "expression": "messaging.endpoint.empty() or kind = 'instance'", "xpath": "not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance'" }, { "key": "cpb-14", "severity": "error", "human": "Capability Statements of kind 'requirements' do not have software or implementation elements.", "expression": "(software.empty() and implementation.empty()) or kind != 'requirements'", "xpath": "not(exists(f:software) or exists(f:implementation)) or (f:kind/@value != 'requirements')" }, { "key": "cpb-2", "severity": "error", "human": "A Capability Statement SHALL have at least one of description, software, or implementation element.", "expression": "(description.count() + software.count() + implementation.count()) > 0", "xpath": "count(f:software | f:implementation | f:description) > 0" }, { "key": "cpb-1", "severity": "error", "human": "A Capability Statement SHALL have at least one of REST, messaging or document element.", "expression": "rest.exists() or messaging.exists() or document.exists()", "xpath": "exists(f:rest) or exists(f:messaging) or exists(f:document)" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "conformance.behavior" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.url", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.url", "path": "CapabilityStatement.url", "short": "Logical URI to reference this capability statement (globally unique)", "definition": "An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the capability statement to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.version", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.version", "path": "CapabilityStatement.version", "short": "Business version of the capability statement", "definition": "The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the capability statement with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.name", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.name", "path": "CapabilityStatement.name", "short": "Name for this capability statement (computer friendly)", "definition": "A natural language name identifying the capability statement. 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.title", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.title", "path": "CapabilityStatement.title", "short": "Name for this capability statement (human friendly)", "definition": "A short, descriptive, user-friendly title for the capability statement.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.status", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.status", "path": "CapabilityStatement.status", "short": "draft | active | retired | unknown", "definition": "The status of this capability statement. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of capability statements that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired capability statement without due consideration. This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.experimental", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.experimental", "path": "CapabilityStatement.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of capability statement that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental capability statement in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.date", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.date", "path": "CapabilityStatement.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the capability statement was published. The date must change if and 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 capability statement 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 capability statement. 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": 1, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.publisher", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.publisher", "path": "CapabilityStatement.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the capability statement.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. 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 capability statement. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the capability statement. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.contact", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.contact", "path": "CapabilityStatement.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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.description", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.description", "path": "CapabilityStatement.description", "short": "Natural language description of the capability statement", "definition": "A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.", "comment": "This description can be used to capture details such as why the capability statement 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 capability statement 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 profile is presumed to be the predominant language in the place the profile was created). This does not need to be populated if the description is adequately implied by the software or implementation details.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "condition": [ "cpb-2" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.useContext", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.useContext", "path": "CapabilityStatement.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.jurisdiction", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.jurisdiction", "path": "CapabilityStatement.jurisdiction", "short": "Intended jurisdiction for capability statement (if applicable)", "definition": "A legal or geographic region in which the capability statement is intended to be used.", "comment": "It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.purpose", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.purpose", "path": "CapabilityStatement.purpose", "short": "Why this capability statement is defined", "definition": "Explaination of why this capability statement is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the capability statement 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 capability statement.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.copyright", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.copyright", "path": "CapabilityStatement.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.kind", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.kind", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.kind", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.kind", "path": "CapabilityStatement.kind", "short": "instance | capability | requirements", "definition": "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).", "requirements": "Allow searching the 3 modes.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CapabilityStatementKind" } ], "strength": "required", "description": "How a capability statement is intended to be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/capability-statement-kind" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.instantiates", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.instantiates", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.instantiates", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.instantiates", "path": "CapabilityStatement.instantiates", "short": "Canonical URL of another capability statement this implements", "definition": "Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.", "comment": "HL7 defines the following Services: [Terminology Service](terminology-service.html).\n\nMany [Implementation Guides](http://fhir.org/guides/registry) define additional services.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.software", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.software", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.software", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.software", "path": "CapabilityStatement.software", "short": "Software that is covered by this capability statement", "definition": "Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "condition": [ "cpb-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.software.name", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.software.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.software.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.software.name", "path": "CapabilityStatement.software.name", "short": "A name the software is known by", "definition": "Name software is known by.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.software.version", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.software.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.software.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.software.version", "path": "CapabilityStatement.software.version", "short": "Version covered by this statement", "definition": "The version identifier for the software covered by this statement.", "comment": "If possible, a version should be specified, as statements are likely to be different for different versions of software.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.software.releaseDate", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.software.releaseDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.software.releaseDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.software.releaseDate", "path": "CapabilityStatement.software.releaseDate", "short": "Date this version released", "definition": "Date this version of the software was released.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.implementation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.implementation", "path": "CapabilityStatement.implementation", "short": "If this describes a specific instance", "definition": "Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "condition": [ "cpb-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementation.description", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.implementation.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementation.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.implementation.description", "path": "CapabilityStatement.implementation.description", "short": "Describes this specific instance", "definition": "Information about the specific installation that this capability statement relates to.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementation.url", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.implementation.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementation.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.implementation.url", "path": "CapabilityStatement.implementation.url", "short": "Base URL for the installation", "definition": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.fhirVersion", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.fhirVersion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.fhirVersion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.fhirVersion", "path": "CapabilityStatement.fhirVersion", "short": "FHIR Version the system uses", "definition": "The version of the FHIR specification on which this capability statement is based.", "min": 1, "max": "1", "type": [ { "code": "id" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.acceptUnknown", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.acceptUnknown", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.acceptUnknown", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.acceptUnknown", "path": "CapabilityStatement.acceptUnknown", "short": "no | extensions | elements | both", "definition": "A code that indicates whether the application accepts unknown elements or extensions when reading resources.", "comment": "Unknown elements in a resource can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence accepting unknown elements is about inter-version compatibility.\n\nApplications are recommended to accept unknown extensions and elements ('both'), but this is not always possible.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "UnknownContentCode" } ], "strength": "required", "description": "A code that indicates whether an application accepts unknown elements or extensions when reading resources.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/unknown-content-code" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.format", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.format", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.format", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.format", "path": "CapabilityStatement.format", "short": "formats supported (xml | json | ttl | mime type)", "definition": "A list of the formats supported by this implementation using their content types.", "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": 1, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.patchFormat", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.patchFormat", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.patchFormat", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.patchFormat", "path": "CapabilityStatement.patchFormat", "short": "Patch formats supported", "definition": "A list of the patch formats supported by this implementation using their content types.", "comment": "At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementationGuide", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.implementationGuide", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.implementationGuide", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.implementationGuide", "path": "CapabilityStatement.implementationGuide", "short": "Implementation guides supported", "definition": "A list of implementation guides that the server does (or should) support in their entirety.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.profile", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.profile", "path": "CapabilityStatement.profile", "short": "Profiles for use cases supported", "definition": "A list of profiles that represent different use cases supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).", "comment": "Supported profiles are different than the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile). Typically, supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However, they do not need to describe more than one resource.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest", "path": "CapabilityStatement.rest", "short": "If the endpoint is a RESTful one", "definition": "A definition of the restful capabilities of the solution, if any.", "comment": "Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "cpb-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "cpb-9", "severity": "error", "human": "A given resource can only be described once per RESTful mode.", "expression": "resource.select(type).isDistinct()", "xpath": "count(f:resource)=count(distinct-values(f:resource/f:type/@value))" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.mode", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.mode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.mode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.mode", "path": "CapabilityStatement.rest.mode", "short": "client | server", "definition": "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RestfulCapabilityMode" } ], "strength": "required", "description": "The mode of a RESTful capability statement.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/restful-capability-mode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.documentation", "path": "CapabilityStatement.rest.documentation", "short": "General description of implementation", "definition": "Information about the system's restful capabilities that apply across all applications, such as security.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.security", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.security", "path": "CapabilityStatement.rest.security", "short": "Information about security of implementation", "definition": "Information about security implementation from an interface perspective - what a client needs to know.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.cors", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.security.cors", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.cors", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.security.cors", "path": "CapabilityStatement.rest.security.cors", "short": "Adds CORS Headers (http://enable-cors.org/)", "definition": "Server adds CORS headers when responding to requests - this enables javascript applications to use the server.", "comment": "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.service", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.security.service", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.service", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.security.service", "path": "CapabilityStatement.rest.security.service", "short": "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates", "definition": "Types of security services that are supported/required by the system.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RestfulSecurityService" } ], "strength": "extensible", "description": "Types of security services used with FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/restful-security-service" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.description", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.security.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.security.description", "path": "CapabilityStatement.rest.security.description", "short": "General description of how security works", "definition": "General description of how security works.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.certificate", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.security.certificate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.certificate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.security.certificate", "path": "CapabilityStatement.rest.security.certificate", "short": "Certificates associated with security profiles", "definition": "Certificates associated with security profiles.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.certificate.type", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.security.certificate.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.certificate.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.security.certificate.type", "path": "CapabilityStatement.rest.security.certificate.type", "short": "Mime type for certificates", "definition": "Mime type for a certificate.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.certificate.blob", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.security.certificate.blob", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.security.certificate.blob", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.security.certificate.blob", "path": "CapabilityStatement.rest.security.certificate.blob", "short": "Actual certificate", "definition": "Actual certificate.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource", "path": "CapabilityStatement.rest.resource", "short": "Resource served on the REST interface", "definition": "A specification of the restful capabilities of the solution for a specific resource type.", "comment": "Max of one repetition per resource type.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "cpb-12", "severity": "error", "human": "Search parameter names must be unique in the context of a resource.", "expression": "searchParam.select(name).isDistinct()", "xpath": "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.type", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.type", "path": "CapabilityStatement.rest.resource.type", "short": "A resource type that is supported", "definition": "A type of resource exposed via the restful interface.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.profile", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.profile", "path": "CapabilityStatement.rest.resource.profile", "short": "Base System profile for all uses of resource", "definition": "A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).", "comment": "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.documentation", "path": "CapabilityStatement.rest.resource.documentation", "short": "Additional information about the use of the resource type", "definition": "Additional information about the resource type used by the system.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.interaction", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.interaction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.interaction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.interaction", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ResourceInteraction" } ], "path": "CapabilityStatement.rest.resource.interaction", "short": "What operations are supported?", "definition": "Identifies a restful operation supported by the solution.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.interaction.code", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.interaction.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.interaction.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.interaction.code", "path": "CapabilityStatement.rest.resource.interaction.code", "short": "read | vread | update | patch | delete | history-instance | history-type | create | search-type", "definition": "Coded identifier of the operation, supported by the system resource.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TypeRestfulInteraction" } ], "strength": "required", "description": "Operations supported by REST at the type or instance level.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/type-restful-interaction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.interaction.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.interaction.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.interaction.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.interaction.documentation", "path": "CapabilityStatement.rest.resource.interaction.documentation", "short": "Anything special about operation behavior", "definition": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.", "requirements": "REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.versioning", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.versioning", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.versioning", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.versioning", "path": "CapabilityStatement.rest.resource.versioning", "short": "no-version | versioned | versioned-update", "definition": "This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.", "comment": "If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceVersionPolicy" } ], "strength": "required", "description": "How the system supports versioning for a resource.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/versioning-policy" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.readHistory", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.readHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.readHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.readHistory", "path": "CapabilityStatement.rest.resource.readHistory", "short": "Whether vRead can return past versions", "definition": "A flag for whether the server is able to return past versions as part of the vRead operation.", "comment": "It is useful to support the vRead operation for current operations, even if past versions aren't available.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.updateCreate", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.updateCreate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.updateCreate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.updateCreate", "path": "CapabilityStatement.rest.resource.updateCreate", "short": "If update can commit to a new identity", "definition": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.", "comment": "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalCreate", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.conditionalCreate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalCreate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.conditionalCreate", "path": "CapabilityStatement.rest.resource.conditionalCreate", "short": "If allows/uses conditional create", "definition": "A flag that indicates that the server supports conditional create.", "comment": "Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalRead", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.conditionalRead", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalRead", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.conditionalRead", "path": "CapabilityStatement.rest.resource.conditionalRead", "short": "not-supported | modified-since | not-match | full-support", "definition": "A code that indicates how the server supports conditional read.", "comment": "Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionalReadStatus" } ], "strength": "required", "description": "A code that indicates how the server supports conditional read.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/conditional-read-status" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalUpdate", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.conditionalUpdate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalUpdate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.conditionalUpdate", "path": "CapabilityStatement.rest.resource.conditionalUpdate", "short": "If allows/uses conditional update", "definition": "A flag that indicates that the server supports conditional update.", "comment": "Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalDelete", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.conditionalDelete", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.conditionalDelete", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.conditionalDelete", "path": "CapabilityStatement.rest.resource.conditionalDelete", "short": "not-supported | single | multiple - how conditional delete is supported", "definition": "A code that indicates how the server supports conditional delete.", "comment": "Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionalDeleteStatus" } ], "strength": "required", "description": "A code that indicates how the server supports conditional delete.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/conditional-delete-status" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.referencePolicy", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.referencePolicy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.referencePolicy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.referencePolicy", "path": "CapabilityStatement.rest.resource.referencePolicy", "short": "literal | logical | resolves | enforced | local", "definition": "A set of flags that defines how references are supported.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferenceHandlingPolicy" } ], "strength": "required", "description": "A set of flags that defines how references are supported.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/reference-handling-policy" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchInclude", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.searchInclude", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchInclude", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.searchInclude", "path": "CapabilityStatement.rest.resource.searchInclude", "short": "_include values supported by the server", "definition": "A list of _include values supported by the server.", "comment": "If this list is empty, the server does not support includes.", "min": 0, "max": "*", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchRevInclude", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.searchRevInclude", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchRevInclude", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.searchRevInclude", "path": "CapabilityStatement.rest.resource.searchRevInclude", "short": "_revinclude values supported by the server", "definition": "A list of _revinclude (reverse include) values supported by the server.", "comment": "If this list is empty, the server does not support reverse includes.", "min": 0, "max": "*", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.searchParam", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.searchParam", "path": "CapabilityStatement.rest.resource.searchParam", "short": "Search parameters supported by implementation", "definition": "Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.name", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.searchParam.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.searchParam.name", "path": "CapabilityStatement.rest.resource.searchParam.name", "short": "Name of search parameter", "definition": "The name of the search parameter used in the interface.", "comment": "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.definition", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.searchParam.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.searchParam.definition", "path": "CapabilityStatement.rest.resource.searchParam.definition", "short": "Source of definition for parameter", "definition": "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url]()).", "comment": "This SHOULD be present, and matches refers to a SearchParameter by its canonical url. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.type", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.searchParam.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.searchParam.type", "path": "CapabilityStatement.rest.resource.searchParam.type", "short": "number | date | string | token | reference | composite | quantity | uri", "definition": "The type of value a search parameter refers to, and how the content is interpreted.", "comment": "While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchParamType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "Data types allowed to be used for search parameters.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/search-param-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.resource.searchParam.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.resource.searchParam.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.resource.searchParam.documentation", "path": "CapabilityStatement.rest.resource.searchParam.documentation", "short": "Server-specific usage", "definition": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.interaction", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.interaction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.interaction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.interaction", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "SystemInteraction" } ], "path": "CapabilityStatement.rest.interaction", "short": "What operations are supported?", "definition": "A specification of restful operations supported by the system.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.interaction.code", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.interaction.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.interaction.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.interaction.code", "path": "CapabilityStatement.rest.interaction.code", "short": "transaction | batch | search-system | history-system", "definition": "A coded identifier of the operation, supported by the system.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SystemRestfulInteraction" } ], "strength": "required", "description": "Operations supported by REST at the system level.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/system-restful-interaction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.interaction.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.interaction.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.interaction.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.interaction.documentation", "path": "CapabilityStatement.rest.interaction.documentation", "short": "Anything special about operation behavior", "definition": "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.searchParam", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.searchParam", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.searchParam", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.searchParam", "path": "CapabilityStatement.rest.searchParam", "short": "Search parameters for searching all resources", "definition": "Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.", "comment": "Typically, the only search parameters supported for all searchse are those that apply to all resources - tags, profiles, text search etc.", "min": 0, "max": "*", "contentReference": "#CapabilityStatement.rest.resource.searchParam" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.operation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.operation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.operation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.operation", "path": "CapabilityStatement.rest.operation", "short": "Definition of an operation or a custom query", "definition": "Definition of an operation or a named query together with its parameters and their meaning and type.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.operation.name", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.operation.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.operation.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.operation.name", "path": "CapabilityStatement.rest.operation.name", "short": "Name by which the operation/query is invoked", "definition": "The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.", "comment": "The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the \"$\" portion that is always included in the URL.", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.operation.definition", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.operation.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.operation.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.operation.definition", "path": "CapabilityStatement.rest.operation.definition", "short": "The defined operation/query", "definition": "Where the formal definition can be found.", "comment": "This can be used to build an HTML form to invoke the operation, for instance.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.compartment", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.rest.compartment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.rest.compartment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.rest.compartment", "path": "CapabilityStatement.rest.compartment", "short": "Compartments served/used by system", "definition": "An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .", "comment": "At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).", "min": 0, "max": "*", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging", "path": "CapabilityStatement.messaging", "short": "If messaging is supported", "definition": "A description of the messaging capabilities of the solution.", "comment": "Multiple repetitions allow the documentation of multiple endpoints per solution.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "cpb-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "cpb-16", "severity": "error", "human": "A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both.", "expression": "supportedMessage.empty() != event.empty()", "xpath": "exists(f:supportedMessage) != exists(f:event)" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.endpoint", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.endpoint", "path": "CapabilityStatement.messaging.endpoint", "short": "Where messages should be sent", "definition": "An endpoint (network accessible address) to which messages and/or replies are to be sent.", "alias": [ "3" ], "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.endpoint.protocol", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.endpoint.protocol", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.endpoint.protocol", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.endpoint.protocol", "path": "CapabilityStatement.messaging.endpoint.protocol", "short": "http | ftp | mllp +", "definition": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MessageTransport" } ], "strength": "extensible", "description": "The protocol used for message transport.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/message-transport" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.endpoint.address", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.endpoint.address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.endpoint.address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.endpoint.address", "path": "CapabilityStatement.messaging.endpoint.address", "short": "Network address or identifier of the end-point", "definition": "The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier.", "min": 1, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.reliableCache", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.reliableCache", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.reliableCache", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.reliableCache", "path": "CapabilityStatement.messaging.reliableCache", "short": "Reliable Message Cache Length (min)", "definition": "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).", "comment": "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.documentation", "path": "CapabilityStatement.messaging.documentation", "short": "Messaging interface behavior details", "definition": "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.supportedMessage", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.supportedMessage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.supportedMessage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.supportedMessage", "path": "CapabilityStatement.messaging.supportedMessage", "short": "Messages supported by this system", "definition": "References to message definitions for messages this system can send or receive.", "comment": "This is a proposed alternative to the messaging.event structure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.supportedMessage.mode", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.supportedMessage.mode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.supportedMessage.mode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.supportedMessage.mode", "path": "CapabilityStatement.messaging.supportedMessage.mode", "short": "sender | receiver", "definition": "The mode of this event declaration - whether application is sender or receiver.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EventCapabilityMode" } ], "strength": "required", "description": "The mode of a message capability statement.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/event-capability-mode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.supportedMessage.definition", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.supportedMessage.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.supportedMessage.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.supportedMessage.definition", "path": "CapabilityStatement.messaging.supportedMessage.definition", "short": "Message supported by this system", "definition": "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MessageDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event", "path": "CapabilityStatement.messaging.event", "short": "Declare support for this event", "definition": "A description of the solution's support for an event at this end-point.", "comment": "The same event may be listed up to two times - once as sender and once as receiver.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.code", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event.code", "path": "CapabilityStatement.messaging.event.code", "short": "Event type", "definition": "A coded identifier of a supported messaging event.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MessageEvent" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "example", "description": "One of the message events defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/message-events" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.category", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event.category", "path": "CapabilityStatement.messaging.event.category", "short": "Consequence | Currency | Notification", "definition": "The impact of the content of the message.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MessageSignificanceCategory" } ], "strength": "required", "description": "The impact of the content of a message.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/message-significance-category" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.mode", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event.mode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.mode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event.mode", "path": "CapabilityStatement.messaging.event.mode", "short": "sender | receiver", "definition": "The mode of this event declaration - whether an application is a sender or receiver.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EventCapabilityMode" } ], "strength": "required", "description": "The mode of a message capability statement.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/event-capability-mode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.focus", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event.focus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.focus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event.focus", "path": "CapabilityStatement.messaging.event.focus", "short": "Resource that's focus of message", "definition": "A resource associated with the event. This is the resource that defines the event.", "comment": "This SHALL be provided if the event type supports multiple different resource types.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.request", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event.request", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.request", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event.request", "path": "CapabilityStatement.messaging.event.request", "short": "Profile that describes the request", "definition": "Information about the request for this event.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.response", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event.response", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.response", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event.response", "path": "CapabilityStatement.messaging.event.response", "short": "Profile that describes the response", "definition": "Information about the response for this event.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.messaging.event.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.messaging.event.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.messaging.event.documentation", "path": "CapabilityStatement.messaging.event.documentation", "short": "Endpoint-specific event documentation", "definition": "Guidance on how this event is handled, such as internal system trigger points, business rules, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.document", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.document", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.document", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.document", "path": "CapabilityStatement.document", "short": "Document definition", "definition": "A document definition.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "cpb-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.document.mode", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.document.mode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.document.mode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.document.mode", "path": "CapabilityStatement.document.mode", "short": "producer | consumer", "definition": "Mode of this document declaration - whether an application is a producer or consumer.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentMode" } ], "strength": "required", "description": "Whether the application produces or consumes documents.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/document-mode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.document.documentation", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.document.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.document.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.document.documentation", "path": "CapabilityStatement.document.documentation", "short": "Description of document support", "definition": "A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CapabilityStatement.document.profile", "resource": { "resourceType": "DataElement", "id": "CapabilityStatement.document.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CapabilityStatement.document.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CapabilityStatement.document.profile", "path": "CapabilityStatement.document.profile", "short": "Constraint on a resource used in the document", "definition": "A constraint on a resource used in the document.", "comment": "The first resource is the document resource.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication", "resource": { "resourceType": "DataElement", "id": "Medication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication", "path": "Medication", "short": "Definition of a Medication", "definition": "This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "script10.6", "map": "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed" }, { "identity": "rim", "map": "ManufacturedProduct[classCode=ADMM]" }, { "identity": "w5", "map": "clinical.medication" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.code", "resource": { "resourceType": "DataElement", "id": "Medication.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.code", "path": "Medication.code", "short": "Codes that identify this medication", "definition": "A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", "comment": "Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: \"A coding may be marked as a \"userSelected\" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationFormalRepresentation" } ], "strength": "example", "description": "A coded concept that defines the type of a medication", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-codes" } }, "mapping": [ { "identity": "script10.6", "map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription" }, { "identity": "v2", "map": "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.status", "resource": { "resourceType": "DataElement", "id": "Medication.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.status", "path": "Medication.status", "short": "active | inactive | entered-in-error", "definition": "A code to indicate if the medication is in active use.", "comment": "This status is not intended to specify if a medication is part of a formulary.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationStatus" } ], "strength": "required", "description": "A coded concept defining if the medication is in active use", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.isBrand", "resource": { "resourceType": "DataElement", "id": "Medication.isBrand", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.isBrand", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.isBrand", "path": "Medication.isBrand", "short": "True if a brand", "definition": "Set to true if the item is attributable to a specific manufacturer.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true, "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "rim", "map": "true if .player.scopingRole[typeCode=MANU] exists" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.isOverTheCounter", "resource": { "resourceType": "DataElement", "id": "Medication.isOverTheCounter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.isOverTheCounter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.isOverTheCounter", "path": "Medication.isOverTheCounter", "short": "True if medication does not require a prescription", "definition": "Set to true if the medication can be obtained without an order from a prescriber.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "NA" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.manufacturer", "resource": { "resourceType": "DataElement", "id": "Medication.manufacturer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.manufacturer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.manufacturer", "path": "Medication.manufacturer", "short": "Manufacturer of the item", "definition": "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "v2", "map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name" }, { "identity": "rim", "map": ".player.scopingRole[typeCode=MANU].scoper" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.form", "resource": { "resourceType": "DataElement", "id": "Medication.form", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.form", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.form", "path": "Medication.form", "short": "powder | tablets | capsule +", "definition": "Describes the form of the item. Powder; tablets; capsule.", "comment": "When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationForm" } ], "strength": "example", "description": "A coded concept defining the form of a medication", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-form-codes" } }, "mapping": [ { "identity": "script10.6", "map": "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode" }, { "identity": "v2", "map": "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form" }, { "identity": "rim", "map": ".formCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.ingredient", "resource": { "resourceType": "DataElement", "id": "Medication.ingredient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.ingredient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.ingredient", "path": "Medication.ingredient", "short": "Active or inactive ingredient", "definition": "Identifies a particular constituent of interest in the product.", "comment": "The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".scopesRole[typeCode=INGR]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.ingredient.itemX", "resource": { "resourceType": "DataElement", "id": "Medication.ingredient.itemX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.ingredient.itemX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "short": "The product contained", "definition": "The actual ingredient - either a substance (simple ingredient) or another medication.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" } ], "mapping": [ { "identity": "script10.6", "map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription" }, { "identity": "v2", "map": "RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code" }, { "identity": "rim", "map": ".player" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.ingredient.isActive", "resource": { "resourceType": "DataElement", "id": "Medication.ingredient.isActive", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.ingredient.isActive", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "short": "Active ingredient indicator", "definition": "Indication of whether this ingredient affects the therapeutic action of the drug.", "requirements": "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "mapping": [ { "identity": "rim", "map": "NA" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.ingredient.amount", "resource": { "resourceType": "DataElement", "id": "Medication.ingredient.amount", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.ingredient.amount", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.ingredient.amount", "path": "Medication.ingredient.amount", "short": "Quantity of ingredient present", "definition": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.", "min": 0, "max": "1", "type": [ { "code": "Ratio" } ], "mapping": [ { "identity": "script10.6", "map": "//element(*,DrugCodedType)/Strength" }, { "identity": "v2", "map": "RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units" }, { "identity": "rim", "map": ".quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package", "resource": { "resourceType": "DataElement", "id": "Medication.package", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package", "path": "Medication.package", "short": "Details about packaged medications", "definition": "Information that only applies to packages (not products).", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "rim", "map": ".player[classCode=CONT]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package.container", "resource": { "resourceType": "DataElement", "id": "Medication.package.container", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package.container", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package.container", "path": "Medication.package.container", "short": "E.g. box, vial, blister-pack", "definition": "The kind of container that this package comes as.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationContainer" } ], "strength": "example", "description": "A coded concept defining the kind of container a medication package is packaged in", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-package-form" } }, "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package.content", "resource": { "resourceType": "DataElement", "id": "Medication.package.content", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package.content", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package.content", "path": "Medication.package.content", "short": "What is in the package", "definition": "A set of components that go to make up the described item.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "rim", "map": ".scopesRole[typeCode=CONT]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package.content.itemX", "resource": { "resourceType": "DataElement", "id": "Medication.package.content.itemX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package.content.itemX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package.content.item[x]", "path": "Medication.package.content.item[x]", "short": "The item in the package", "definition": "Identifies one of the items in the package.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" } ], "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "rim", "map": ".player" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package.content.amount", "resource": { "resourceType": "DataElement", "id": "Medication.package.content.amount", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package.content.amount", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package.content.amount", "path": "Medication.package.content.amount", "short": "Quantity present in the package", "definition": "The amount of the product that is in the package.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "rim", "map": ".quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package.batch", "resource": { "resourceType": "DataElement", "id": "Medication.package.batch", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package.batch", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package.batch", "path": "Medication.package.batch", "short": "Identifies a single production run", "definition": "Information about a group of medication produced or packaged from one production run.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "rim", "map": "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package.batch.lotNumber", "resource": { "resourceType": "DataElement", "id": "Medication.package.batch.lotNumber", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package.batch.lotNumber", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package.batch.lotNumber", "path": "Medication.package.batch.lotNumber", "short": "Identifier assigned to batch", "definition": "The assigned lot number of a batch of the specified product.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "v2", "map": "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number" }, { "identity": "rim", "map": ".id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.package.batch.expirationDate", "resource": { "resourceType": "DataElement", "id": "Medication.package.batch.expirationDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.package.batch.expirationDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.package.batch.expirationDate", "path": "Medication.package.batch.expirationDate", "short": "When batch will expire", "definition": "When this specific batch of product will expire.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "script10.6", "map": "no mapping" }, { "identity": "v2", "map": "RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date" }, { "identity": "rim", "map": "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Medication.image", "resource": { "resourceType": "DataElement", "id": "Medication.image", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Medication.image", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Medication.image", "path": "Medication.image", "short": "Picture of the medication", "definition": "Photo(s) or graphic representation(s) of the medication.", "requirements": "Note that \"image\" is only applicable when the medication.code represents a physical item (e.g. Amoxil 250 mg capsule) and not an abstract item (e.g. amoxicillin 250 mg).", "min": 0, "max": "*", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SUBJ].role[classCode=MANU],source[classCode=OBS,moodCode=EVN,code=\"type of image\"].value(ED.image)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure", "resource": { "resourceType": "DataElement", "id": "Measure", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure", "path": "Measure", "short": "A quality measure definition", "definition": "The Measure resource provides the definition of a quality measure.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Definition" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.url", "resource": { "resourceType": "DataElement", "id": "Measure.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.url", "path": "Measure.url", "short": "Logical URI to reference this measure (globally unique)", "definition": "An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the measure to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.identifier", "resource": { "resourceType": "DataElement", "id": "Measure.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.identifier", "path": "Measure.identifier", "short": "Additional identifier for the measure", "definition": "A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.", "comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this measure 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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.identifier" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.version", "resource": { "resourceType": "DataElement", "id": "Measure.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.version", "path": "Measure.version", "short": "Business version of the measure", "definition": "The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", "comment": "There may be different measure instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the measure with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.name", "resource": { "resourceType": "DataElement", "id": "Measure.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.name", "path": "Measure.name", "short": "Name for this measure (computer friendly)", "definition": "A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.", "comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.title", "resource": { "resourceType": "DataElement", "id": "Measure.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.title", "path": "Measure.title", "short": "Name for this measure (human friendly)", "definition": "A short, descriptive, user-friendly title for the measure.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.status", "resource": { "resourceType": "DataElement", "id": "Measure.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.status", "path": "Measure.status", "short": "draft | active | retired | unknown", "definition": "The status of this measure. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of measures that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired measure without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "workflow", "map": "Definition.status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.experimental", "resource": { "resourceType": "DataElement", "id": "Measure.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.experimental", "path": "Measure.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of measure that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental measure in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level measure.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.date", "resource": { "resourceType": "DataElement", "id": "Measure.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.date", "path": "Measure.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the measure was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.", "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. 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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.publisher", "resource": { "resourceType": "DataElement", "id": "Measure.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.publisher", "path": "Measure.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the measure.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the measure is the organization or individual primarily responsible for the maintenance and upkeep of the measure. 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 measure. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the measure. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.description", "resource": { "resourceType": "DataElement", "id": "Measure.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.description", "path": "Measure.description", "short": "Natural language description of the measure", "definition": "A free text natural language description of the measure from a consumer's perspective.", "comment": "This description can be used to capture details such as why the measure 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 measure 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.description" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.purpose", "resource": { "resourceType": "DataElement", "id": "Measure.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.purpose", "path": "Measure.purpose", "short": "Why this measure is defined", "definition": "Explaination of why this measure is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the measure 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 measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.usage", "resource": { "resourceType": "DataElement", "id": "Measure.usage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.usage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.usage", "path": "Measure.usage", "short": "Describes the clinical usage of the measure", "definition": "A detailed description of how the measure is used from a clinical perspective.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.approvalDate", "resource": { "resourceType": "DataElement", "id": "Measure.approvalDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.approvalDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.approvalDate", "path": "Measure.approvalDate", "short": "When the measure was approved by publisher", "definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "workflow", "map": "Definition.approvalDate" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.lastReviewDate", "resource": { "resourceType": "DataElement", "id": "Measure.lastReviewDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.lastReviewDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.lastReviewDate", "path": "Measure.lastReviewDate", "short": "When the measure was last reviewed", "definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.", "comment": "If specified, this is usually after the approval date.", "requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "workflow", "map": "Definition.lastReviewDate" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.effectivePeriod", "resource": { "resourceType": "DataElement", "id": "Measure.effectivePeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.effectivePeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.effectivePeriod", "path": "Measure.effectivePeriod", "short": "When the measure is expected to be used", "definition": "The period during which the measure content was or is planned to be in active use.", "comment": "The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.", "requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the measure are or are expected to be used instead.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.effectivePeriod" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.useContext", "resource": { "resourceType": "DataElement", "id": "Measure.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.useContext", "path": "Measure.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate measure instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.jurisdiction", "resource": { "resourceType": "DataElement", "id": "Measure.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.jurisdiction", "path": "Measure.jurisdiction", "short": "Intended jurisdiction for measure (if applicable)", "definition": "A legal or geographic region in which the measure is intended to be used.", "comment": "It may be possible for the measure to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.topic", "resource": { "resourceType": "DataElement", "id": "Measure.topic", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.topic", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.topic", "path": "Measure.topic", "short": "E.g. Education, Treatment, Assessment, etc", "definition": "Descriptive topics related to the content of the measure. Topics provide a high-level categorization of the type of the measure that can be useful for filtering and searching.", "requirements": "Repositories must be able to determine how to categorize the measure so that it can be found by topical searches.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DefinitionTopic" } ], "strength": "example", "description": "High-level categorization of the definition, used for searching, sorting, and filtering", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/definition-topic" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.contributor", "resource": { "resourceType": "DataElement", "id": "Measure.contributor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.contributor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.contributor", "path": "Measure.contributor", "short": "A content contributor", "definition": "A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.", "requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the measure.", "min": 0, "max": "*", "type": [ { "code": "Contributor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.contact", "resource": { "resourceType": "DataElement", "id": "Measure.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.contact", "path": "Measure.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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.copyright", "resource": { "resourceType": "DataElement", "id": "Measure.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.copyright", "path": "Measure.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the measure and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.copyright" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.relatedArtifact", "resource": { "resourceType": "DataElement", "id": "Measure.relatedArtifact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.relatedArtifact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.relatedArtifact", "path": "Measure.relatedArtifact", "short": "Additional documentation, citations, etc", "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.", "comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.", "requirements": "Measures must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.library", "resource": { "resourceType": "DataElement", "id": "Measure.library", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.library", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.library", "path": "Measure.library", "short": "Logic used by the measure", "definition": "A reference to a Library resource containing the formal logic used by the measure.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Library" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.disclaimer", "resource": { "resourceType": "DataElement", "id": "Measure.disclaimer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.disclaimer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.disclaimer", "path": "Measure.disclaimer", "short": "Disclaimer for use of the measure or its referenced content", "definition": "Notices and disclaimers regarding the use of the measure, or related to intellectual property (such as code systems) referenced by the measure.", "requirements": "Some organizations require that notices and disclosures be included when publishing measures that reference their intellecutal property.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.scoring", "resource": { "resourceType": "DataElement", "id": "Measure.scoring", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.scoring", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.scoring", "path": "Measure.scoring", "short": "proportion | ratio | continuous-variable | cohort", "definition": "Indicates how the calculation is performed for the measure, including proportion, ratio, continuous variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureScoring" } ], "strength": "extensible", "description": "The scoring type of the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-scoring" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.compositeScoring", "resource": { "resourceType": "DataElement", "id": "Measure.compositeScoring", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.compositeScoring", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.compositeScoring", "path": "Measure.compositeScoring", "short": "opportunity | all-or-nothing | linear | weighted", "definition": "If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CompositeMeasureScoring" } ], "strength": "extensible", "description": "The composite scoring method of the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/composite-measure-scoring" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.type", "resource": { "resourceType": "DataElement", "id": "Measure.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.type", "path": "Measure.type", "short": "process | outcome | structure | patient-reported-outcome | composite", "definition": "Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureType" } ], "strength": "extensible", "description": "The type of measure (includes codes from 2.16.840.1.113883.1.11.20368)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-type" } }, "mapping": [ { "identity": "workflow", "map": "Definition.subjectCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.riskAdjustment", "resource": { "resourceType": "DataElement", "id": "Measure.riskAdjustment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.riskAdjustment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.riskAdjustment", "path": "Measure.riskAdjustment", "short": "How is risk adjustment applied for this measure", "definition": "A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.", "comment": "Describes the method of adjusting for clinical severity and conditions present at the start of care that can influence patient outcomes for making valid comparisons of outcome measures across providers. Indicates whether an eMeasure is subject to the statistical process for reducing, removing, or clarifying the influences of confounding factors to allow more useful comparisons.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.rateAggregation", "resource": { "resourceType": "DataElement", "id": "Measure.rateAggregation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.rateAggregation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.rateAggregation", "path": "Measure.rateAggregation", "short": "How is rate aggregation performed for this measure", "definition": "Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.", "comment": "The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.rationale", "resource": { "resourceType": "DataElement", "id": "Measure.rationale", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.rationale", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.rationale", "path": "Measure.rationale", "short": "Why does this measure exist", "definition": "Provides a succint statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.clinicalRecommendationStatement", "resource": { "resourceType": "DataElement", "id": "Measure.clinicalRecommendationStatement", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.clinicalRecommendationStatement", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.clinicalRecommendationStatement", "path": "Measure.clinicalRecommendationStatement", "short": "Summary of clinical guidelines", "definition": "Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.improvementNotation", "resource": { "resourceType": "DataElement", "id": "Measure.improvementNotation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.improvementNotation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.improvementNotation", "path": "Measure.improvementNotation", "short": "Improvement notation for the measure, e.g. higher score indicates better quality", "definition": "Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is whthin a range).", "requirements": "Measure consumers and implementers must be able to determine how to interpret a measure score.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.definition", "resource": { "resourceType": "DataElement", "id": "Measure.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.definition", "path": "Measure.definition", "short": "Defined terms used in the measure documentation", "definition": "Provides a description of an individual term used within the measure.", "requirements": "Measure developers must be able to provide precise definitions of terms used within measure descriptions and guidance to help communicate the intent of the measure.", "min": 0, "max": "*", "type": [ { "code": "markdown" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.guidance", "resource": { "resourceType": "DataElement", "id": "Measure.guidance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.guidance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.guidance", "path": "Measure.guidance", "short": "Additional guidance for implementers", "definition": "Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.", "requirements": "Measure developers must be able to provide additional guidance for implementers to understand the intent with greater specificity than that provided in the logic of the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.set", "resource": { "resourceType": "DataElement", "id": "Measure.set", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.set", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.set", "path": "Measure.set", "short": "The measure set, e.g. Preventive Care and Screening", "definition": "The measure set, e.g. Preventive Care and Screening.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group", "resource": { "resourceType": "DataElement", "id": "Measure.group", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group", "path": "Measure.group", "short": "Population criteria group", "definition": "A group of population criteria for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.identifier", "resource": { "resourceType": "DataElement", "id": "Measure.group.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.identifier", "path": "Measure.group.identifier", "short": "Unique identifier", "definition": "A unique identifier for the group. This identifier will used to report data for the group in the measure report.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.name", "resource": { "resourceType": "DataElement", "id": "Measure.group.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.name", "path": "Measure.group.name", "short": "Short name", "definition": "Optional name or short description of this group.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.description", "resource": { "resourceType": "DataElement", "id": "Measure.group.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.description", "path": "Measure.group.description", "short": "Summary description", "definition": "The human readable description of this population group.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.population", "resource": { "resourceType": "DataElement", "id": "Measure.group.population", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.population", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.population", "path": "Measure.group.population", "short": "Population criteria", "definition": "A population criteria for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.population.identifier", "resource": { "resourceType": "DataElement", "id": "Measure.group.population.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.population.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.population.identifier", "path": "Measure.group.population.identifier", "short": "Unique identifier", "definition": "A unique identifier for the population criteria. This identifier is used to report data against this criteria within the measure report.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.population.code", "resource": { "resourceType": "DataElement", "id": "Measure.group.population.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.population.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.population.code", "path": "Measure.group.population.code", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation", "definition": "The type of population criteria.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasurePopulationType" } ], "strength": "extensible", "description": "The type of population", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-population" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.population.name", "resource": { "resourceType": "DataElement", "id": "Measure.group.population.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.population.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.population.name", "path": "Measure.group.population.name", "short": "Short name", "definition": "Optional name or short description of this population.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.population.description", "resource": { "resourceType": "DataElement", "id": "Measure.group.population.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.population.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.population.description", "path": "Measure.group.population.description", "short": "The human readable description of this population criteria", "definition": "The human readable description of this population criteria.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.population.criteria", "resource": { "resourceType": "DataElement", "id": "Measure.group.population.criteria", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.population.criteria", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.population.criteria", "path": "Measure.group.population.criteria", "short": "The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria", "definition": "The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria.", "comment": "In the case of a continuous variable or ratio measure, this may be the name of a function that calculates the value of the individual observation for each patient or event in the population. For these types of measures, individual observations are reported as observation resources included in the evaluatedResources bundle for each patient. See the MeasureReport resource or the Quality Reporting topic for more information.", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.stratifier", "resource": { "resourceType": "DataElement", "id": "Measure.group.stratifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.stratifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.stratifier", "path": "Measure.group.stratifier", "short": "Stratifier criteria for the measure", "definition": "The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library, or a valid FHIR Resource Path.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.stratifier.identifier", "resource": { "resourceType": "DataElement", "id": "Measure.group.stratifier.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.stratifier.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.stratifier.identifier", "path": "Measure.group.stratifier.identifier", "short": "The identifier for the stratifier used to coordinate the reported data back to this stratifier", "definition": "The identifier for the stratifier used to coordinate the reported data back to this stratifier.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.stratifier.criteria", "resource": { "resourceType": "DataElement", "id": "Measure.group.stratifier.criteria", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.stratifier.criteria", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.stratifier.criteria", "path": "Measure.group.stratifier.criteria", "short": "How the measure should be stratified", "definition": "The criteria for the stratifier. This must be the name of an expression defined within a referenced library.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.group.stratifier.path", "resource": { "resourceType": "DataElement", "id": "Measure.group.stratifier.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.group.stratifier.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.group.stratifier.path", "path": "Measure.group.stratifier.path", "short": "Path to the stratifier", "definition": "The path to an element that defines the stratifier, specified as a valid FHIR resource path.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.supplementalData", "resource": { "resourceType": "DataElement", "id": "Measure.supplementalData", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.supplementalData", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.supplementalData", "path": "Measure.supplementalData", "short": "What other data should be reported with the measure", "definition": "The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.", "comment": "Note that supplemental data are reported as observations for each patient and included in the evaluatedResources bundle. See the MeasureReport resource or the Quality Reporting topic for more information.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.supplementalData.identifier", "resource": { "resourceType": "DataElement", "id": "Measure.supplementalData.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.supplementalData.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.supplementalData.identifier", "path": "Measure.supplementalData.identifier", "short": "Identifier, unique within the measure", "definition": "An identifier for the supplemental data.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.supplementalData.usage", "resource": { "resourceType": "DataElement", "id": "Measure.supplementalData.usage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.supplementalData.usage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.supplementalData.usage", "path": "Measure.supplementalData.usage", "short": "supplemental-data | risk-adjustment-factor", "definition": "An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureDataUsage" } ], "strength": "extensible", "description": "The intended usage for supplemental data elements in the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-data-usage" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.supplementalData.criteria", "resource": { "resourceType": "DataElement", "id": "Measure.supplementalData.criteria", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.supplementalData.criteria", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.supplementalData.criteria", "path": "Measure.supplementalData.criteria", "short": "Expression describing additional data to be reported", "definition": "The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Measure.supplementalData.path", "resource": { "resourceType": "DataElement", "id": "Measure.supplementalData.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Measure.supplementalData.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Measure.supplementalData.path", "path": "Measure.supplementalData.path", "short": "Path to the supplemental data element", "definition": "The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject", "resource": { "resourceType": "DataElement", "id": "ResearchSubject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject", "path": "ResearchSubject", "short": "Investigation to increase healthcare-related patient-independent knowledge", "definition": "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.", "comment": "Need to make sure we encompass public health studies.", "alias": [ "Study Subject" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "Observation[classCode=CLNTRL, moodCode=EVN]" }, { "identity": "w5", "map": "clinical.diagnostics" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.identifier", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.identifier", "path": "ResearchSubject.identifier", "short": "Business Identifier for research subject", "definition": "Identifiers assigned to this research study by the sponsor or other systems.", "requirements": "Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.status", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.status", "path": "ResearchSubject.status", "short": "candidate | enrolled | active | suspended | withdrawn | completed", "definition": "The current state of the subject.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResearchSubjectStatus" } ], "strength": "required", "description": "Indicates the progression of a study subject through a study", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/research-subject-status" } }, "mapping": [ { "identity": "rim", "map": ".status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.period", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.period", "path": "ResearchSubject.period", "short": "Start and end of participation", "definition": "The dates the subject began and ended their participation in the study.", "alias": [ "timing" ], "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.planned" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.study", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.study", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.study", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.study", "path": "ResearchSubject.study", "short": "Study subject is part of", "definition": "Reference to the study the subject is participating in.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ResearchStudy" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.individual", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.individual", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.individual", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.individual", "path": "ResearchSubject.individual", "short": "Who is part of study", "definition": "The record of the person or animal who is involved in the study.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.assignedArm", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.assignedArm", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.assignedArm", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.assignedArm", "path": "ResearchSubject.assignedArm", "short": "What path should be followed", "definition": "The name of the arm in the study the subject is expected to follow as part of this study.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.actualArm", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.actualArm", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.actualArm", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.actualArm", "path": "ResearchSubject.actualArm", "short": "What path was followed", "definition": "The name of the arm in the study the subject actually followed as part of this study.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchSubject.consent", "resource": { "resourceType": "DataElement", "id": "ResearchSubject.consent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchSubject.consent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchSubject.consent", "path": "ResearchSubject.consent", "short": "Agreement to participate in study", "definition": "A record of the patient's informed agreement to participate in the study.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Consent" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription", "resource": { "resourceType": "DataElement", "id": "Subscription", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription", "path": "Subscription", "short": "A server push subscription criteria", "definition": "The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system is able to take an appropriate action.", "alias": [ "WebHook", "Hook", "Routing Rule" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "infrastructure.exchange" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.status", "resource": { "resourceType": "DataElement", "id": "Subscription.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.status", "path": "Subscription.status", "short": "requested | active | error | off", "definition": "The status of the subscription, which marks the server state for managing the subscription.", "comment": "A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubscriptionStatus" } ], "strength": "required", "description": "The status of a subscription.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/subscription-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.contact", "resource": { "resourceType": "DataElement", "id": "Subscription.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.contact", "path": "Subscription.contact", "short": "Contact details for source (e.g. troubleshooting)", "definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.", "min": 0, "max": "*", "type": [ { "code": "ContactPoint" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.end", "resource": { "resourceType": "DataElement", "id": "Subscription.end", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.end", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.end", "path": "Subscription.end", "short": "When to automatically delete the subscription", "definition": "The time for the server to turn the subscription off.", "comment": "The server is permitted to deviate from this time, but should observe it.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.reason", "resource": { "resourceType": "DataElement", "id": "Subscription.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.reason", "path": "Subscription.reason", "short": "Description of why this subscription was created", "definition": "A description of why this subscription is defined.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.criteria", "resource": { "resourceType": "DataElement", "id": "Subscription.criteria", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.criteria", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.criteria", "path": "Subscription.criteria", "short": "Rule for server push criteria", "definition": "The rules that the server should use to determine when to generate notifications for this subscription.", "comment": "The rules are a search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.error", "resource": { "resourceType": "DataElement", "id": "Subscription.error", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.error", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.error", "path": "Subscription.error", "short": "Latest error note", "definition": "A record of the last error that occurred when the server processed a notification.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.channel", "resource": { "resourceType": "DataElement", "id": "Subscription.channel", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.channel", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.channel", "path": "Subscription.channel", "short": "The channel on which to report matches to the criteria", "definition": "Details where to send notifications when resources are received that meet the criteria.", "min": 1, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.channel.type", "resource": { "resourceType": "DataElement", "id": "Subscription.channel.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.channel.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.channel.type", "path": "Subscription.channel.type", "short": "rest-hook | websocket | email | sms | message", "definition": "The type of channel to send notifications on.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubscriptionChannelType" } ], "strength": "required", "description": "The type of method used to execute a subscription.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/subscription-channel-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.channel.endpoint", "resource": { "resourceType": "DataElement", "id": "Subscription.channel.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.channel.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.channel.endpoint", "path": "Subscription.channel.endpoint", "short": "Where the channel points to", "definition": "The uri that describes the actual end-point to send messages to.", "comment": "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs).", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.channel.payload", "resource": { "resourceType": "DataElement", "id": "Subscription.channel.payload", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.channel.payload", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.channel.payload", "path": "Subscription.channel.payload", "short": "Mimetype to send, or omit for no payload", "definition": "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification.", "comment": "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.channel.header", "resource": { "resourceType": "DataElement", "id": "Subscription.channel.header", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.channel.header", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.channel.header", "path": "Subscription.channel.header", "short": "Usage depends on the channel type", "definition": "Additional headers / information to send as part of the notification.", "comment": "Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Subscription.tag", "resource": { "resourceType": "DataElement", "id": "Subscription.tag", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Subscription.tag", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Subscription.tag", "path": "Subscription.tag", "short": "A tag to add to matching resources", "definition": "A tag to add to any resource that matches the criteria, after the subscription is processed.", "comment": "So that other systems can tell which resources have been the subject of a notification.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubscriptionTag" } ], "strength": "example", "description": "Tags to put on a resource after subscriptions have been sent.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/subscription-tag" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference", "resource": { "resourceType": "DataElement", "id": "DocumentReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference", "path": "DocumentReference", "short": "A reference to a document", "definition": "A reference to a document.", "comment": "Usually, this is used for documents other than those defined by FHIR.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]" }, { "identity": "w5", "map": "infrastructure.documents" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.masterIdentifier", "resource": { "resourceType": "DataElement", "id": "DocumentReference.masterIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.masterIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.masterIdentifier", "path": "DocumentReference.masterIdentifier", "short": "Master Version Specific Identifier", "definition": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.", "comment": "CDA Document Id extension and root.", "requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form \"oid^extension\", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-12" }, { "identity": "rim", "map": ".id" }, { "identity": "xds", "map": "DocumentEntry.uniqueId" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.identifier", "resource": { "resourceType": "DataElement", "id": "DocumentReference.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.identifier", "path": "DocumentReference.identifier", "short": "Other identifiers for the document", "definition": "Other identifiers associated with the document, including version independent identifiers.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-16?" }, { "identity": "rim", "map": ".id / .setId" }, { "identity": "xds", "map": "DocumentEntry.entryUUID" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.status", "resource": { "resourceType": "DataElement", "id": "DocumentReference.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.status", "path": "DocumentReference.status", "short": "current | superseded | entered-in-error", "definition": "The status of this document reference.", "comment": "This is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentReferenceStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The status of the document reference.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/document-reference-status" } }, "mapping": [ { "identity": "v2", "map": "TXA-19" }, { "identity": "rim", "map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"" }, { "identity": "xds", "map": "DocumentEntry status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.docStatus", "resource": { "resourceType": "DataElement", "id": "DocumentReference.docStatus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.docStatus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.docStatus", "path": "DocumentReference.docStatus", "short": "preliminary | final | appended | amended | entered-in-error", "definition": "The status of the underlying document.", "comment": "The document that is pointed to might be in various lifecycle states.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferredDocumentStatus" } ], "strength": "required", "description": "Status of the underlying document.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/composition-status" } }, "mapping": [ { "identity": "v2", "map": "TXA-17" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.type", "resource": { "resourceType": "DataElement", "id": "DocumentReference.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.type", "path": "DocumentReference.type", "short": "Kind of document (LOINC if possible)", "definition": "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", "comment": "Key metadata element describing the document, used in searching/filtering.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80Type" } ], "strength": "preferred", "description": "Precise type of clinical document.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes" } }, "mapping": [ { "identity": "v2", "map": "TXA-2" }, { "identity": "rim", "map": "./code" }, { "identity": "xds", "map": "DocumentEntry.type" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.class", "resource": { "resourceType": "DataElement", "id": "DocumentReference.class", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.class", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.class", "path": "DocumentReference.class", "short": "Categorization of document", "definition": "A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", "comment": "This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD)).", "requirements": "Helps humans to assess whether the document is of interest when viewing a list of documents.", "alias": [ "kind" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80Class" } ], "strength": "example", "description": "High-level kind of a clinical document at a macro level.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-doc-classcodes" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "xds", "map": "DocumentEntry.class" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.subject", "resource": { "resourceType": "DataElement", "id": "DocumentReference.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.subject", "path": "DocumentReference.subject", "short": "Who/what is the subject of the document", "definition": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" }, { "identity": "xds", "map": "DocumentEntry.patientId" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.created", "resource": { "resourceType": "DataElement", "id": "DocumentReference.created", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.created", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.created", "path": "DocumentReference.created", "short": "Document creation time", "definition": "When the document was created.", "comment": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-6" }, { "identity": "rim", "map": ".effectiveTime[type=\"TS\"]" }, { "identity": "xds", "map": "DocumentEntry.submissionTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.indexed", "resource": { "resourceType": "DataElement", "id": "DocumentReference.indexed", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.indexed", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.indexed", "path": "DocumentReference.indexed", "short": "When this document reference was created", "definition": "When the document reference was created.", "comment": "Referencing/indexing time is used for tracking, organizing versions and searching.", "min": 1, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".availabilityTime[type=\"TS\"]" }, { "identity": "xds", "map": "DocumentEntry.submissionTime" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.author", "resource": { "resourceType": "DataElement", "id": "DocumentReference.author", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.author", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.author", "path": "DocumentReference.author", "short": "Who and/or what authored the document", "definition": "Identifies who is responsible for adding the information to the document.", "comment": "Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "xds", "map": "DocumentEntry.author" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.authenticator", "resource": { "resourceType": "DataElement", "id": "DocumentReference.authenticator", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.authenticator", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.authenticator", "path": "DocumentReference.authenticator", "short": "Who/what authenticated the document", "definition": "Which person or organization authenticates that this document is valid.", "comment": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-10" }, { "identity": "rim", "map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "xds", "map": "DocumentEntry.legalAuthenticator" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.custodian", "resource": { "resourceType": "DataElement", "id": "DocumentReference.custodian", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.custodian", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.custodian", "path": "DocumentReference.custodian", "short": "Organization which maintains the document", "definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.", "comment": "Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.relatesTo", "resource": { "resourceType": "DataElement", "id": "DocumentReference.relatesTo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.relatesTo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.relatesTo", "path": "DocumentReference.relatesTo", "short": "Relationships to other documents", "definition": "Relationships that this document has with other document references that already exist.", "comment": "This element is labeled as a modifier because documents that append to other documents are incomplete on their own.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.relatesTo.code", "resource": { "resourceType": "DataElement", "id": "DocumentReference.relatesTo.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.relatesTo.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.relatesTo.code", "path": "DocumentReference.relatesTo.code", "short": "replaces | transforms | signs | appends", "definition": "The type of relationship that this document has with anther document.", "comment": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentRelationshipType" } ], "strength": "required", "description": "The type of relationship between documents.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/document-relationship-type" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship.typeCode" }, { "identity": "xds", "map": "DocumentEntry Associations type" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.relatesTo.target", "resource": { "resourceType": "DataElement", "id": "DocumentReference.relatesTo.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.relatesTo.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.relatesTo.target", "path": "DocumentReference.relatesTo.target", "short": "Target of the relationship", "definition": "The target document of this relationship.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" }, { "identity": "xds", "map": "DocumentEntry Associations reference" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.description", "resource": { "resourceType": "DataElement", "id": "DocumentReference.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.description", "path": "DocumentReference.description", "short": "Human-readable description (title)", "definition": "Human-readable description of the source document. This is sometimes known as the \"title\".", "comment": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").", "requirements": "Helps humans to assess whether the document is of interest.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-25" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text" }, { "identity": "xds", "map": "DocumentEntry.description" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.securityLabel", "resource": { "resourceType": "DataElement", "id": "DocumentReference.securityLabel", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.securityLabel", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.securityLabel", "path": "DocumentReference.securityLabel", "short": "Document security-tags", "definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.", "comment": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.", "requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } }, "mapping": [ { "identity": "v2", "map": "TXA-18" }, { "identity": "rim", "map": ".confidentialityCode" }, { "identity": "xds", "map": "DocumentEntry.confidentialityCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.content", "resource": { "resourceType": "DataElement", "id": "DocumentReference.content", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.content", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.content", "path": "DocumentReference.content", "short": "Document referenced", "definition": "The document and format referenced. There may be multiple content element repetitions, each with a different format.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "document.text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.content.attachment", "resource": { "resourceType": "DataElement", "id": "DocumentReference.content.attachment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.content.attachment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.content.attachment", "path": "DocumentReference.content.attachment", "short": "Where to access the document", "definition": "The document or URL of the document along with critical metadata to prove content has integrity.", "min": 1, "max": "1", "type": [ { "code": "Attachment" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-3 for mime type" }, { "identity": "rim", "map": "document.text" }, { "identity": "xds", "map": "DocumentEntry.mimeType DocumentEntry.languageCode DocumentEntry.URI DocumentEntry.size DocumentEntry.hash DocumentEntry.title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.content.format", "resource": { "resourceType": "DataElement", "id": "DocumentReference.content.format", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.content.format", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.content.format", "path": "DocumentReference.content.format", "short": "Format/content rules for the document", "definition": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.", "comment": "Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentFormat" } ], "strength": "preferred", "description": "Document Format Codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/formatcodes" } }, "mapping": [ { "identity": "rim", "map": "document.text" }, { "identity": "xds", "map": "DocumentEntry.formatCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context", "path": "DocumentReference.context", "short": "Clinical context of document", "definition": "The clinical context in which the document was prepared.", "comment": "These values are primarily added to help with searching for interesting/relevant documents.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.encounter", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.encounter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.encounter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.encounter", "path": "DocumentReference.context.encounter", "short": "Context of the document content", "definition": "Describes the clinical encounter or type of care that the document content is associated with.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.event", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.event", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.event", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.event", "path": "DocumentReference.context.event", "short": "Main clinical acts documented", "definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", "comment": "An event can further specialize the act inherent in the type, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentEventType" } ], "strength": "example", "description": "This list of codes represents the main clinical acts being documented.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActCode" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "xds", "map": "DocumentEntry.eventCodeList" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.period", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.period", "path": "DocumentReference.context.period", "short": "Time of service that is being documented", "definition": "The time period over which the service that is described by the document was provided.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "xds", "map": "DocumentEntry.serviceStartTime DocumentEntry.serviceStopTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.facilityType", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.facilityType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.facilityType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.facilityType", "path": "DocumentReference.context.facilityType", "short": "Kind of facility where patient was seen", "definition": "The kind of facility where the patient was seen.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80FacilityType" } ], "strength": "example", "description": "XDS Facility Type.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" } }, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" }, { "identity": "xds", "map": "DocumentEntry.healthcareFacilityTypeCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.practiceSetting", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.practiceSetting", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.practiceSetting", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.practiceSetting", "path": "DocumentReference.context.practiceSetting", "short": "Additional details about where the content was created (e.g. clinical specialty)", "definition": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", "comment": "The value set for this content has an example binding because it is a value set decided by community policy. Other examples exist for consideration: * HITSP created the table HITSP/C80 Table 2-148 Clinical Specialty Value Set (a value set based upon SNOMED CT which is referenced by Direct (XDR and XDM for Direct Messaging Specification, Version 1), as well as Nationwide Health Information Network (NHIN). Query for Documents, Web Service Interface Specification, V 3.0, 07/27/2011 * ELGA (Austria) (ELGA CDA Implementie-rungsleitfäden Registrierung von CDA Dokumenten für ELGA mit IHE Cross-Enterprise Document Sharing: XDS Metadaten (XDSDocumentEntry), [1.2.40.0.34.7.6.3] * XDS Connect-a-thon practiceSettingCode.", "requirements": "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80PracticeSetting" } ], "strength": "example", "description": "Additional details about where the content was created (e.g. clinical specialty).", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" }, { "identity": "xds", "map": "DocumentEntry.practiceSettingCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.sourcePatientInfo", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.sourcePatientInfo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.sourcePatientInfo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.sourcePatientInfo", "path": "DocumentReference.context.sourcePatientInfo", "short": "Patient demographics from source", "definition": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" }, { "identity": "xds", "map": "DocumentEntry.sourcePatientInfo DocumentEntry.sourcePatientId" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.related", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.related", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.related", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.related", "path": "DocumentReference.context.related", "short": "Related identifiers or resources", "definition": "Related identifiers or resources associated with the DocumentReference.", "comment": "May be identifiers or resources that caused the DocumentReference or referenced Document to be created.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct]" }, { "identity": "xds", "map": "DocumentEntry.referenceIdList" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.related.identifier", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.related.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.related.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.related.identifier", "path": "DocumentReference.context.related.identifier", "short": "Identifier of related objects or events", "definition": "Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.", "comment": "Order numbers, accession numbers, XDW workflow numbers.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct] .id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DocumentReference.context.related.ref", "resource": { "resourceType": "DataElement", "id": "DocumentReference.context.related.ref", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DocumentReference.context.related.ref", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DocumentReference.context.related.ref", "path": "DocumentReference.context.related.ref", "short": "Related Resource", "definition": "Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.", "comment": "Order, ProcedureRequest, Procedure, EligibilityRequest, etc.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct].text.reference" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition", "resource": { "resourceType": "DataElement", "id": "GraphDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition", "path": "GraphDefinition", "short": "Definition of an graph of resources", "definition": "A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Definition" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "conformance.behavior" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.url", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.url", "path": "GraphDefinition.url", "short": "Logical URI to reference this graph definition (globally unique)", "definition": "An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the graph definition to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.version", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.version", "path": "GraphDefinition.version", "short": "Business version of the graph definition", "definition": "The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph 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 graph definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the graph definition with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.name", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.name", "path": "GraphDefinition.name", "short": "Name for this graph definition (computer friendly)", "definition": "A natural language name identifying the graph 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.status", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.status", "path": "GraphDefinition.status", "short": "draft | active | retired | unknown", "definition": "The status of this graph definition. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of graph definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired graph definition without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "workflow", "map": "Definition.status (different ValueSet)" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.experimental", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.experimental", "path": "GraphDefinition.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of graph definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental graph definition in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level graph definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.date", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.date", "path": "GraphDefinition.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the graph definition was published. The date must change if and 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 graph 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 graph 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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.publisher", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.publisher", "path": "GraphDefinition.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the graph definition.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the graph definition is the organization or individual primarily responsible for the maintenance and upkeep of the graph 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 graph definition. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the graph definition. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.contact", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.contact", "path": "GraphDefinition.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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.description", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.description", "path": "GraphDefinition.description", "short": "Natural language description of the graph definition", "definition": "A free text natural language description of the graph definition from a consumer's perspective.", "comment": "This description can be used to capture details such as why the graph 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 graph 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.description" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.useContext", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.useContext", "path": "GraphDefinition.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.jurisdiction", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.jurisdiction", "path": "GraphDefinition.jurisdiction", "short": "Intended jurisdiction for graph definition (if applicable)", "definition": "A legal or geographic region in which the graph definition is intended to be used.", "comment": "It may be possible for the graph definition to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.purpose", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.purpose", "path": "GraphDefinition.purpose", "short": "Why this graph definition is defined", "definition": "Explaination of why this graph definition is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the graph 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 graph definition.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.start", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.start", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.start", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.start", "path": "GraphDefinition.start", "short": "Type of resource at which the graph starts", "definition": "The type of FHIR resource at which instances of this graph start.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.profile", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.profile", "path": "GraphDefinition.profile", "short": "Profile on base resource", "definition": "The profile that describes the use of the base resource.", "comment": "The code does not include the '$' prefix that is always included in the URL when the operation is invoked.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link", "path": "GraphDefinition.link", "short": "Links this graph makes rules about", "definition": "Links this graph makes rules about.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.path", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.path", "path": "GraphDefinition.link.path", "short": "Path in the resource that contains the link", "definition": "Path in the resource that contains the link.", "comment": "The path can be a literal path (e.g. Observation.subject), or it can be a query for reverse links (e.g. Provenance?target=[id]).", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.sliceName", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.sliceName", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.sliceName", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.sliceName", "path": "GraphDefinition.link.sliceName", "short": "Which slice (if profiled)", "definition": "Which slice (if profiled).", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.min", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.min", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.min", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.min", "path": "GraphDefinition.link.min", "short": "Minimum occurrences for this link", "definition": "Minimum occurrences for this link.", "min": 0, "max": "1", "type": [ { "code": "integer" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.max", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.max", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.max", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.max", "path": "GraphDefinition.link.max", "short": "Maximum occurrences for this link", "definition": "Maximum occurrences for this link.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.description", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.description", "path": "GraphDefinition.link.description", "short": "Why this link is specified", "definition": "Information about why this link is of interest in this graph definition.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target", "path": "GraphDefinition.link.target", "short": "Potential target for the link", "definition": "Potential target for the link.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.type", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.type", "path": "GraphDefinition.link.target.type", "short": "Type of resource this link refers to", "definition": "Type of resource this link refers to.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.profile", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.profile", "path": "GraphDefinition.link.target.profile", "short": "Profile for the target resource", "definition": "Profile for the target resource.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.compartment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.compartment", "path": "GraphDefinition.link.target.compartment", "short": "Compartment Consistency Rules", "definition": "Compartment Consistency Rules.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.code", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.compartment.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.compartment.code", "path": "GraphDefinition.link.target.compartment.code", "short": "Identifies the compartment", "definition": "Identifies the compartment.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CompartmentCode" } ], "strength": "required", "description": "Identifies a compartment", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/compartment-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.rule", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.compartment.rule", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.rule", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.compartment.rule", "path": "GraphDefinition.link.target.compartment.rule", "short": "identical | matching | different | custom", "definition": "identical | matching | different | no-rule | custom.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GraphCompartmentRule" } ], "strength": "required", "description": "How a compartment must be linked", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/graph-compartment-rule" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.expression", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.compartment.expression", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.expression", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.compartment.expression", "path": "GraphDefinition.link.target.compartment.expression", "short": "Custom rule, as a FHIRPath expression", "definition": "Custom rule, as a FHIRPath expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.description", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.compartment.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.compartment.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.compartment.description", "path": "GraphDefinition.link.target.compartment.description", "short": "Documentation for FHIRPath expression", "definition": "Documentation for FHIRPath expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.link", "resource": { "resourceType": "DataElement", "id": "GraphDefinition.link.target.link", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/GraphDefinition.link.target.link", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "GraphDefinition.link.target.link", "path": "GraphDefinition.link.target.link", "short": "Additional links from target resource", "definition": "Additional links from target resource.", "min": 0, "max": "*", "contentReference": "#GraphDefinition.link" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest", "resource": { "resourceType": "DataElement", "id": "ImagingManifest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest", "path": "ImagingManifest", "short": "Key Object Selection", "definition": "A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.", "alias": [ "Manifest", "XDS-I summary", "Key Images", "(in limited use) Key Object Selection (KOS)" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[classCode=COMPOSITION, moodCode=EVN]" }, { "identity": "dicom", "map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)" }, { "identity": "w5", "map": "clinical.diagnostics" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.identifier", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.identifier", "path": "ImagingManifest.identifier", "short": "SOP Instance UID", "definition": "Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.", "requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).", "alias": [ "SOPInstanceUID" ], "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "dicom", "map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.patient", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.patient", "path": "ImagingManifest.patient", "short": "Patient of the selected objects", "definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.", "comment": "SOP instances selected in the ImagingManifest can be from different studies, but must be of the same patient.", "requirements": "SOP Instances in ImagingManifest must be from the same patient.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "dicom", "map": "(0010,0010) - Patient Name (0010,0020) - Patient ID (0010,0021) - Issuer of Patient ID" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.authoringTime", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.authoringTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.authoringTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.authoringTime", "path": "ImagingManifest.authoringTime", "short": "Time when the selection of instances was made", "definition": "Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).", "requirements": "Date and time when the selection was made can be important to understand the content of selection.", "alias": [ "ObservationDateTime" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "dicom", "map": "(0040,A032) - Observation Date Time" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.author", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.author", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.author", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.author", "path": "ImagingManifest.author", "short": "Author (human or machine)", "definition": "Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.", "requirements": "Track the selection decision maker.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PRF].role" }, { "identity": "dicom", "map": "(0040,A730) - Content Sequence TID 1002 - Observer Context" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.description", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.description", "path": "ImagingManifest.description", "short": "Description text", "definition": "Free text narrative description of the ImagingManifest. \nThe value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.", "comment": "Free text narrative description of the ImagingManifest.", "requirements": "Need to provide a narrative description of the SOP instances in the selection.", "alias": [ "TextValue" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "dicom", "map": "(0040,A160) - Text Value SR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Study" } ], "path": "ImagingManifest.study", "short": "Study identity of the selected instances", "definition": "Study identity and locating information of the DICOM SOP instances in the selection.", "comment": "Study component represents the study level identity and locator information of the DICOM SOP instances in the selection. It is the top level identity of the hierarchical identification of the instances.", "requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Act[classCode=COMPOSITION, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.uid", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.uid", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.uid", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.uid", "path": "ImagingManifest.study.uid", "short": "Study instance UID", "definition": "Study instance UID of the SOP instances in the selection.", "requirements": "Study instance UID is required to fully identify the DICOM SOP instances in the selection.", "alias": [ "StudyInstanceUID", "Referenced study instance UID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "dicom", "map": "(0020,000D) - Study Instance UID" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.imagingStudy", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.imagingStudy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.imagingStudy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.imagingStudy", "path": "ImagingManifest.study.imagingStudy", "short": "Reference to ImagingStudy", "definition": "Reference to the Imaging Study in FHIR form.", "requirements": "Used to retrieve the ImagingStudy that contain the images referenced in the Imaging ObjectSelection.study.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "dicom", "map": "imagingStudy (0020,000D) - Study Instance UID" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.endpoint", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.endpoint", "path": "ImagingManifest.study.endpoint", "short": "Study access service endpoint", "definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.", "requirements": "Access methods for viewing (e.g. IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.series", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.series", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Series" } ], "path": "ImagingManifest.study.series", "short": "Series identity of the selected instances", "definition": "Series identity and locating information of the DICOM SOP instances in the selection.", "comment": "Series component represents the series level identity and locator information of the DICOM SOP instances in the selection.", "requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provides a means of retrieving the entire series.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.uid", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.series.uid", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.uid", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.series.uid", "path": "ImagingManifest.study.series.uid", "short": "Series instance UID", "definition": "Series instance UID of the SOP instances in the selection.", "requirements": "Series instance UID is required to fully identify the DICOM SOP instances in the selection.", "alias": [ "SeriesInstanceUID", "Referenced series instance UID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "dicom", "map": "(0020,000E) - Series Instance UID" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.endpoint", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.series.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.series.endpoint", "path": "ImagingManifest.study.series.endpoint", "short": "Series access endpoint", "definition": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.", "requirements": "Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.instance", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.series.instance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.instance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.series.instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Instance" } ], "path": "ImagingManifest.study.series.instance", "short": "The selected instance", "definition": "Identity and locating information of the selected DICOM SOP instances.", "comment": "SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierarchy.", "requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.instance.sopClass", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.series.instance.sopClass", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.instance.sopClass", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.series.instance.sopClass", "path": "ImagingManifest.study.series.instance.sopClass", "short": "SOP class UID of instance", "definition": "SOP class UID of the selected instance.", "comment": "SOP class UID identifies the type of the selected instances, e.g. CT image, Gray scale softcopy presentation state, ECG waveform, etc.", "requirements": "DICOM SOP instances can be an image or other data object. The SOP class UID provide the accurate information about what type the instance is.", "alias": [ "SOPClassUID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value" }, { "identity": "dicom", "map": "(0008,0016) SOP Class UID" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.instance.uid", "resource": { "resourceType": "DataElement", "id": "ImagingManifest.study.series.instance.uid", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingManifest.study.series.instance.uid", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingManifest.study.series.instance.uid", "path": "ImagingManifest.study.series.instance.uid", "short": "Selected instance UID", "definition": "SOP Instance UID of the selected instance.", "comment": "SOP instance UID identifies the instance.", "requirements": "SOP instance UID is required to fully identify the DICOM SOP instance in the selection.", "alias": [ "SOPInstanceUID", "Referenced SOP instance UID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "dicom", "map": "(0008,0018) - SOP Instance UID" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport", "resource": { "resourceType": "DataElement", "id": "MeasureReport", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport", "path": "MeasureReport", "short": "Results of a measure evaluation", "definition": "The MeasureReport resource contains the results of evaluating a measure.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.identifier", "resource": { "resourceType": "DataElement", "id": "MeasureReport.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.identifier", "path": "MeasureReport.identifier", "short": "Additional identifier for the Report", "definition": "A formal identifier that is used to identify this report 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 data type - e.g. to identify this {{title}} outside of FHIR, where the logical URL is not possible to use.", "requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.status", "resource": { "resourceType": "DataElement", "id": "MeasureReport.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.status", "path": "MeasureReport.status", "short": "complete | pending | error", "definition": "The report status. No data will be available until the report status is complete.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureReportStatus" } ], "strength": "required", "description": "The status of the measure report", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-report-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.type", "resource": { "resourceType": "DataElement", "id": "MeasureReport.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.type", "path": "MeasureReport.type", "short": "individual | patient-list | summary", "definition": "The type of measure report. This may be an individual report, which provides a single patient's score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureReportType" } ], "strength": "required", "description": "The type of the measure report", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-report-type" } }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.measure", "resource": { "resourceType": "DataElement", "id": "MeasureReport.measure", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.measure", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.measure", "path": "MeasureReport.measure", "short": "What measure was evaluated", "definition": "A reference to the Measure that was evaluated to produce this report.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Measure" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.definition" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.patient", "resource": { "resourceType": "DataElement", "id": "MeasureReport.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.patient", "path": "MeasureReport.patient", "short": "What patient the report is for", "definition": "Optional Patient if the report was requested for a single patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.date", "resource": { "resourceType": "DataElement", "id": "MeasureReport.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.date", "path": "MeasureReport.date", "short": "When the report was generated", "definition": "The date this measure report was generated.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrenceDateTime" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.reportingOrganization", "resource": { "resourceType": "DataElement", "id": "MeasureReport.reportingOrganization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.reportingOrganization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.reportingOrganization", "path": "MeasureReport.reportingOrganization", "short": "Who is reporting the data", "definition": "Reporting Organization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.period", "resource": { "resourceType": "DataElement", "id": "MeasureReport.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.period", "path": "MeasureReport.period", "short": "What period the report covers", "definition": "The reporting period for which the report was calculated.", "min": 1, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group", "path": "MeasureReport.group", "short": "Measure results for each group", "definition": "The results of the calculation, one for each population group in the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.identifier", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.identifier", "path": "MeasureReport.group.identifier", "short": "What group of the measure", "definition": "The identifier of the population group as defined in the measure definition.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.population", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.population", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.population", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.population", "path": "MeasureReport.group.population", "short": "The populations in the group", "definition": "The populations that make up the population group, one for each type of population appropriate for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.identifier", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.population.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.population.identifier", "path": "MeasureReport.group.population.identifier", "short": "Population identifier as defined in the measure", "definition": "The identifier of the population being reported, as defined by the population element of the measure.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.code", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.population.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.population.code", "path": "MeasureReport.group.population.code", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score", "definition": "The type of the population.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasurePopulation" } ], "strength": "extensible", "description": "The type of population (e.g. initial, numerator, denominator, etc.)", "valueSetUri": "http://hl7.org/fhir/ValueSet/measure-population" } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.count", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.population.count", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.count", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.population.count", "path": "MeasureReport.group.population.count", "short": "Size of the population", "definition": "The number of members of the population.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.patients", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.population.patients", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.population.patients", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.population.patients", "path": "MeasureReport.group.population.patients", "short": "For patient-list reports, the patients in this population", "definition": "This element refers to a List of patient level MeasureReport resources, one for each patient in this population.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/List" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.measureScore", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.measureScore", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.measureScore", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.measureScore", "path": "MeasureReport.group.measureScore", "short": "What score this group achieved", "definition": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier", "path": "MeasureReport.group.stratifier", "short": "Stratification results", "definition": "When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.identifier", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.identifier", "path": "MeasureReport.group.stratifier.identifier", "short": "What stratifier of the group", "definition": "The identifier of this stratifier, as defined in the measure definition.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StratifierGroup" } ], "path": "MeasureReport.group.stratifier.stratum", "short": "Stratum results, one for each unique value in the stratifier", "definition": "This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.value", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum.value", "path": "MeasureReport.group.stratifier.stratum.value", "short": "The stratum value, e.g. male", "definition": "The value for this stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum.population", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum.population", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StratifierGroupPopulation" } ], "path": "MeasureReport.group.stratifier.stratum.population", "short": "Population results in this stratum", "definition": "The populations that make up the stratum, one for each type of population appropriate to the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.identifier", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum.population.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum.population.identifier", "path": "MeasureReport.group.stratifier.stratum.population.identifier", "short": "Population identifier as defined in the measure", "definition": "The identifier of the population being reported, as defined by the population element of the measure.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.code", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum.population.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum.population.code", "path": "MeasureReport.group.stratifier.stratum.population.code", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score", "definition": "The type of the population.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasurePopulation" } ], "strength": "extensible", "description": "The type of population (e.g. initial, numerator, denominator, etc.)", "valueSetUri": "http://hl7.org/fhir/ValueSet/measure-population" } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.count", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum.population.count", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.count", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum.population.count", "path": "MeasureReport.group.stratifier.stratum.population.count", "short": "Size of the population", "definition": "The number of members of the population in this stratum.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.patients", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum.population.patients", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.population.patients", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum.population.patients", "path": "MeasureReport.group.stratifier.stratum.population.patients", "short": "For patient-list reports, the patients in this population", "definition": "This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratum.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/List" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.measureScore", "resource": { "resourceType": "DataElement", "id": "MeasureReport.group.stratifier.stratum.measureScore", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.group.stratifier.stratum.measureScore", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.group.stratifier.stratum.measureScore", "path": "MeasureReport.group.stratifier.stratum.measureScore", "short": "What score this stratum achieved", "definition": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MeasureReport.evaluatedResources", "resource": { "resourceType": "DataElement", "id": "MeasureReport.evaluatedResources", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MeasureReport.evaluatedResources", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MeasureReport.evaluatedResources", "path": "MeasureReport.evaluatedResources", "short": "What data was evaluated to produce the measure score", "definition": "A reference to a Bundle containing the Resources that were used in the evaluation of this report.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Bundle" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole", "resource": { "resourceType": "DataElement", "id": "PractitionerRole", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole", "path": "PractitionerRole", "short": "Roles/organizations the practitioner is associated with", "definition": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "PRD (as one example)" }, { "identity": "rim", "map": "Role" }, { "identity": "servd", "map": "ServiceSiteProvider" }, { "identity": "w5", "map": "administrative.individual" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.identifier", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.identifier", "path": "PractitionerRole.identifier", "short": "Business Identifiers that are specific to a role/location", "definition": "Business Identifiers that are specific to a role/location.", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-7 (or XCN.1)" }, { "identity": "rim", "map": ".id" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.active", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.active", "path": "PractitionerRole.active", "short": "Whether this practitioner's record is in active use", "definition": "Whether this practitioner's record is in active use.", "comment": "Default is true. \r\rIf 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" } ], "defaultValueBoolean": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "STF-7" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.period", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.period", "path": "PractitionerRole.period", "short": "The period during which the practitioner is authorized to perform in these role(s)", "definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", "requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-8/9 / PRA-5.4" }, { "identity": "rim", "map": ".performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.practitioner", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.practitioner", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.practitioner", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.practitioner", "path": "PractitionerRole.practitioner", "short": "Practitioner that is able to provide the defined services for the organation", "definition": "Practitioner that is able to provide the defined services for the organation.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".player" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.organization", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.organization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.organization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.organization", "path": "PractitionerRole.organization", "short": "Organization where the roles are available", "definition": "The organization where the Practitioner performs the roles associated.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.code", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.code", "path": "PractitionerRole.code", "short": "Roles which this practitioner may perform", "definition": "Roles which this practitioner is authorized to perform for the organization.", "comment": "A person may have more than one role. At least one role is required.", "requirements": "Need to know what authority the practitioner has - what can they do?", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PractitionerRole" } ], "strength": "example", "description": "The role a person plays representing an organization", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/practitioner-role" } }, "mapping": [ { "identity": "v2", "map": "PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17" }, { "identity": "rim", "map": ".code" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.specialty", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.specialty", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.specialty", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.specialty", "path": "PractitionerRole.specialty", "short": "Specific specialty of the practitioner", "definition": "Specific specialty of the practitioner.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PractitionerSpecialty" } ], "strength": "preferred", "description": "Specific specialty associated with the agency", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, "mapping": [ { "identity": "v2", "map": "PRA-5" }, { "identity": "rim", "map": ".player.HealthCareProvider[@classCode = 'PROV'].code" }, { "identity": "servd", "map": "./Specialty" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.location", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.location", "path": "PractitionerRole.location", "short": "The location(s) at which this practitioner provides care", "definition": "The location(s) at which this practitioner provides care.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)" }, { "identity": "w5", "map": "where" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.healthcareService", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.healthcareService", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.healthcareService", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.healthcareService", "path": "PractitionerRole.healthcareService", "short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" } ], "mapping": [ { "identity": "v2", "map": "EDU-2 / AFF-3" }, { "identity": "rim", "map": ".player.QualifiedEntity[@classCode = 'QUAL'].code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.telecom", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.telecom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.telecom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.telecom", "path": "PractitionerRole.telecom", "short": "Contact details that are specific to the role/location/service", "definition": "Contact details that are specific to the role/location/service.", "requirements": "Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.", "min": 0, "max": "*", "type": [ { "code": "ContactPoint" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".telecom" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.availableTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.availableTime", "path": "PractitionerRole.availableTime", "short": "Times the Service Site is available", "definition": "A collection of times that the Service Site is available.", "comment": "More detailed availability information may be provided in associated Schedule/Slot resources.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.daysOfWeek", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.availableTime.daysOfWeek", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.daysOfWeek", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.availableTime.daysOfWeek", "path": "PractitionerRole.availableTime.daysOfWeek", "short": "mon | tue | wed | thu | fri | sat | sun", "definition": "Indicates which days of the week are available between the start and end Times.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DaysOfWeek" } ], "strength": "required", "description": "The days of the week.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/days-of-week" } }, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.allDay", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.availableTime.allDay", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.allDay", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.availableTime.allDay", "path": "PractitionerRole.availableTime.allDay", "short": "Always available? e.g. 24 hour service", "definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.availableStartTime", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.availableTime.availableStartTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.availableStartTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.availableTime.availableStartTime", "path": "PractitionerRole.availableTime.availableStartTime", "short": "Opening time of day (ignored if allDay = true)", "definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.", "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "min": 0, "max": "1", "type": [ { "code": "time" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.availableEndTime", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.availableTime.availableEndTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.availableTime.availableEndTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.availableTime.availableEndTime", "path": "PractitionerRole.availableTime.availableEndTime", "short": "Closing time of day (ignored if allDay = true)", "definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.", "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "min": 0, "max": "1", "type": [ { "code": "time" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.notAvailable", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.notAvailable", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.notAvailable", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.notAvailable", "path": "PractitionerRole.notAvailable", "short": "Not available during this time due to provided reason", "definition": "The HealthcareService is not available during this period of time due to the provided reason.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.notAvailable.description", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.notAvailable.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.notAvailable.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.notAvailable.description", "path": "PractitionerRole.notAvailable.description", "short": "Reason presented to the user explaining why time not available", "definition": "The reason that can be presented to the user as to why this time is not available.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.notAvailable.during", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.notAvailable.during", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.notAvailable.during", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.notAvailable.during", "path": "PractitionerRole.notAvailable.during", "short": "Service not availablefrom this date", "definition": "Service is not available (seasonally or for a public holiday) from this date.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.availabilityExceptions", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.availabilityExceptions", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.availabilityExceptions", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.availabilityExceptions", "path": "PractitionerRole.availabilityExceptions", "short": "Description of availability exceptions", "definition": "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PractitionerRole.endpoint", "resource": { "resourceType": "DataElement", "id": "PractitionerRole.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PractitionerRole.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PractitionerRole.endpoint", "path": "PractitionerRole.endpoint", "short": "Technical endpoints providing access to services operated for the practitioner with this role", "definition": "Technical endpoints providing access to services operated for the practitioner with this role.", "requirements": "Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.\r\rSo the endpoint satisfies the 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" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson", "resource": { "resourceType": "DataElement", "id": "RelatedPerson", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson", "path": "RelatedPerson", "short": "An person that is related to a patient, but who is not a direct target of care", "definition": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "role" }, { "identity": "w5", "map": "administrative.individual" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.identifier", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "short": "A human identifier for this person", "definition": "Identifier for a person within a particular scope.", "requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "NK1-33" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.active", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.active", "path": "RelatedPerson.active", "short": "Whether this related person's record is in active use", "definition": "Whether this related person record is in active use.", "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.patient", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.patient", "path": "RelatedPerson.patient", "short": "The patient this person is related to", "definition": "The patient this person is related to.", "requirements": "We need to know which patient this RelatedPerson is related to.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.relationship", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.relationship", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.relationship", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "short": "The nature of the relationship", "definition": "The nature of the relationship between a patient and the related person.", "requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PatientRelationshipType" } ], "strength": "preferred", "description": "The nature of the relationship between a patient and the related person", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" } }, "mapping": [ { "identity": "v2", "map": "NK1-3" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.name", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.name", "path": "RelatedPerson.name", "short": "A name associated with the person", "definition": "A name associated with the person.", "requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.", "min": 0, "max": "*", "type": [ { "code": "HumanName" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "NK1-2" }, { "identity": "rim", "map": "name" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.telecom", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.telecom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.telecom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.telecom", "path": "RelatedPerson.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": "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 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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "NK1-5 / NK1-6 / NK1-40" }, { "identity": "rim", "map": "telecom" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.gender", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.gender", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.gender", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.gender", "path": "RelatedPerson.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 for identification of the person, in combination with (at least) name and birth date.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/administrative-gender" } }, "mapping": [ { "identity": "v2", "map": "NK1-15" }, { "identity": "rim", "map": "administrativeGender" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.birthDate", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.birthDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.birthDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.birthDate", "path": "RelatedPerson.birthDate", "short": "The date on which the related person was born", "definition": "The date on which the related person was born.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "player.birthTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.address", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.address", "path": "RelatedPerson.address", "short": "Address where the related person can be contacted or visited", "definition": "Address where the related person can be contacted or visited.", "requirements": "Need to keep track where the related person can be contacted per postal mail or visited.", "min": 0, "max": "*", "type": [ { "code": "Address" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "NK1-4" }, { "identity": "rim", "map": "addr" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.photo", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.photo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.photo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.photo", "path": "RelatedPerson.photo", "short": "Image of the person", "definition": "Image of the person.", "requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.", "min": 0, "max": "*", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "v2", "map": "OBX-5 - needs a profile" }, { "identity": "rim", "map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RelatedPerson.period", "resource": { "resourceType": "DataElement", "id": "RelatedPerson.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RelatedPerson.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RelatedPerson.period", "path": "RelatedPerson.period", "short": "Period of time that this relationship is considered valid", "definition": "The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest", "resource": { "resourceType": "DataElement", "id": "SupplyRequest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest", "path": "SupplyRequest", "short": "Request for a medication, substance or device", "definition": "A record of a request for a medication, substance or device used in the healthcare setting.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": "Act[moodCode<=INT]" }, { "identity": "w5", "map": "workflow.order" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.identifier", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.identifier", "path": "SupplyRequest.identifier", "short": "Unique identifier", "definition": "Unique identifier for this supply request.", "comment": "This is assigned by the requester, and used to refer to this order in other external standards.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "v2", "map": "ORC.2, ORC.3" }, { "identity": "rim", "map": ".identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.status", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.status", "path": "SupplyRequest.status", "short": "draft | active | suspended +", "definition": "Status of the supply request.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SupplyRequestStatus" } ], "strength": "required", "description": "Status of the supply request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "v2", "map": "ORC.5" }, { "identity": "rim", "map": ".status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.category", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.category", "path": "SupplyRequest.category", "short": "The kind of supply (central, non-stock, etc.)", "definition": "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.", "alias": [ "kind" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SupplyRequestKind" } ], "strength": "example", "description": "Category of supply request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-kind" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.priority", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.priority", "path": "SupplyRequest.priority", "short": "routine | urgent | asap | stat", "definition": "Indicates how quickly this SupplyRequest should be addressed with respect to other requests.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this task should be performed with normal priority", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "description": "Identifies the level of importance to be assigned to actioning the request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "v2", "map": "TQ1.9" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.orderedItem", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.orderedItem", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.orderedItem", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.orderedItem", "path": "SupplyRequest.orderedItem", "short": "The item being requested", "definition": "The item being requested.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.code" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.orderedItem.quantity", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.orderedItem.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.orderedItem.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.orderedItem.quantity", "path": "SupplyRequest.orderedItem.quantity", "short": "The requested amount of the item indicated", "definition": "The amount that is being ordered of the indicated item.", "min": 1, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.orderedItem.itemX", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.orderedItem.itemX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.orderedItem.itemX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.orderedItem.item[x]", "path": "SupplyRequest.orderedItem.item[x]", "short": "Medication, Substance, or Device requested to be supplied", "definition": "The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.", "comment": "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SupplyRequestItem" } ], "strength": "example", "description": "The item that was requested", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supply-item" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.occurrenceX", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.occurrenceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.occurrenceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.occurrence[x]", "path": "SupplyRequest.occurrence[x]", "short": "When the request should be fulfilled", "definition": "When the request should be fulfilled.", "alias": [ "when", "timing" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.occurrence.occurrenceTiming" }, { "identity": "v2", "map": "Accompanying TQ1/TQ2 segments" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.planned" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.authoredOn", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.authoredOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.authoredOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.authoredOn", "path": "SupplyRequest.authoredOn", "short": "When the request was made", "definition": "When the request was made.", "alias": [ "date", "createdOn", "signedOn" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "v2", "map": "ORC.9" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.requester", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.requester", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.requester", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.requester", "path": "SupplyRequest.requester", "short": "Who/what is requesting service", "definition": "The individual who initiated the request and has responsibility for its activation.", "alias": [ "author", "source" ], "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "v2", "map": "ORC.12" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.requester.agent", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.requester.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.requester.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.requester.agent", "path": "SupplyRequest.requester.agent", "short": "Individual making the request", "definition": "The device, practitioner, etc. who initiated the request.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester.agent" }, { "identity": "v2", "map": "ORC.12" }, { "identity": "rim", "map": ".player" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.requester.onBehalfOf", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.requester.onBehalfOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.requester.onBehalfOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.requester.onBehalfOf", "path": "SupplyRequest.requester.onBehalfOf", "short": "Organization agent is acting for", "definition": "The organization the device or practitioner was acting on behalf of.", "requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "workflow", "map": "Request.requester.onBehalfOf" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.supplier", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.supplier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.supplier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.supplier", "path": "SupplyRequest.supplier", "short": "Who is intended to fulfill the request", "definition": "Who is intended to fulfill the request.", "alias": [ "performer" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "v2", "map": "PRT" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.reasonX", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.reasonX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.reasonX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.reason[x]", "path": "SupplyRequest.reason[x]", "short": "Why the supply item was requested", "definition": "Why the supply item was requested.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SupplyRequestReason" } ], "strength": "example", "description": "Why the supply item was requested", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-reason" } }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode, Request.reasonReference" }, { "identity": "v2", "map": "ORC.16" }, { "identity": "rim", "map": ".reasonCode, .outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.deliverFrom", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.deliverFrom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.deliverFrom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.deliverFrom", "path": "SupplyRequest.deliverFrom", "short": "The origin of the supply", "definition": "Where the supply is expected to come from.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "v2", "map": "PRT" }, { "identity": "rim", "map": ".participation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SupplyRequest.deliverTo", "resource": { "resourceType": "DataElement", "id": "SupplyRequest.deliverTo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SupplyRequest.deliverTo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SupplyRequest.deliverTo", "path": "SupplyRequest.deliverTo", "short": "The destination of the supply", "definition": "Where the supply is destined to go.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "mapping": [ { "identity": "v2", "map": "PRT" }, { "identity": "rim", "map": ".participation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner", "resource": { "resourceType": "DataElement", "id": "Practitioner", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner", "status": "draft", "experimental": true, "stringency": "fully-specified", "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.", "comment": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "PRD (as one example)" }, { "identity": "rim", "map": "Role" }, { "identity": "servd", "map": "Provider" }, { "identity": "w5", "map": "administrative.individual" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.identifier", "resource": { "resourceType": "DataElement", "id": "Practitioner.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Practitioner.identifier", "path": "Practitioner.identifier", "short": "A 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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-7 (or XCN.1)" }, { "identity": "rim", "map": "./id" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.active", "resource": { "resourceType": "DataElement", "id": "Practitioner.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": "Default is true. \r\rIf 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" } ], "defaultValueBoolean": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "./statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.name", "resource": { "resourceType": "DataElement", "id": "Practitioner.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XCN Components" }, { "identity": "rim", "map": "./name" }, { "identity": "servd", "map": "./PreferredName (GivenNames, FamilyName, TitleCode)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.telecom", "resource": { "resourceType": "DataElement", "id": "Practitioner.telecom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.telecom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 also to help with identification\r\rThese 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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRT-15, STF-10, ROL-12" }, { "identity": "rim", "map": "./telecom" }, { "identity": "servd", "map": "./ContactPoints" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.address", "resource": { "resourceType": "DataElement", "id": "Practitioner.address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-24, STF-11, ROL-11, PRT-14" }, { "identity": "rim", "map": "./addr" }, { "identity": "servd", "map": "./Addresses" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.gender", "resource": { "resourceType": "DataElement", "id": "Practitioner.gender", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.gender", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/administrative-gender" } }, "mapping": [ { "identity": "v2", "map": "STF-5" }, { "identity": "rim", "map": "./administrativeGender" }, { "identity": "servd", "map": "./GenderCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.birthDate", "resource": { "resourceType": "DataElement", "id": "Practitioner.birthDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.birthDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "STF-6" }, { "identity": "rim", "map": "./birthTime" }, { "identity": "servd", "map": "(not represented in ServD)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.photo", "resource": { "resourceType": "DataElement", "id": "Practitioner.photo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.photo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "rim", "map": "./subjectOf/ObservationEvent[code=\"photo\"]/value" }, { "identity": "servd", "map": "./ImageURI (only supports the URI reference)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.qualification", "resource": { "resourceType": "DataElement", "id": "Practitioner.qualification", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.qualification", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Practitioner.qualification", "path": "Practitioner.qualification", "short": "Qualifications obtained by training and certification", "definition": "Qualifications obtained by training and certification.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "v2", "map": "CER?" }, { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].code" }, { "identity": "servd", "map": "./Qualifications" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.qualification.identifier", "resource": { "resourceType": "DataElement", "id": "Practitioner.qualification.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.qualification.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 in this role.", "requirements": "Often, specific identities are assigned for the qualification.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.qualification.code", "resource": { "resourceType": "DataElement", "id": "Practitioner.qualification.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.qualification.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Qualification" } ], "strength": "example", "description": "Specific qualification the practitioner has to provide a service", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-2.7-0360" } }, "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].code" }, { "identity": "servd", "map": "./Qualifications.Value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.qualification.period", "resource": { "resourceType": "DataElement", "id": "Practitioner.qualification.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.qualification.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].effectiveTime" }, { "identity": "servd", "map": "./Qualifications.StartDate and ./Qualifications.EndDate" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.qualification.issuer", "resource": { "resourceType": "DataElement", "id": "Practitioner.qualification.issuer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.qualification.issuer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Practitioner.communication", "resource": { "resourceType": "DataElement", "id": "Practitioner.communication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Practitioner.communication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Practitioner.communication", "path": "Practitioner.communication", "short": "A language the practitioner is able to use in patient communication", "definition": "A language the practitioner is able to use in patient communication.", "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": "Knowing which language a practitioner speaks can help in facilitating communication with patients.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "mapping": [ { "identity": "v2", "map": "PID-15, NK1-20, LAN-2" }, { "identity": "rim", "map": "./languageCommunication" }, { "identity": "servd", "map": "./Languages.LanguageSpokenCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile", "path": "ExpansionProfile", "short": "Defines behaviour and contraints on the ValueSet Expansion operation", "definition": "Resource to define constraints on the Expansion of a FHIR ValueSet.", "alias": [ "ValueSetExpansionProfile" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "conformance.terminology" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.url", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.url", "path": "ExpansionProfile.url", "short": "Logical URI to reference this expansion profile (globally unique)", "definition": "An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the expansion profile to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.identifier", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.identifier", "path": "ExpansionProfile.identifier", "short": "Additional identifier for the expansion profile", "definition": "A formal identifier that is used to identify this expansion profile 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, e.g., to identify this expansion profile 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": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.version", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.version", "path": "ExpansionProfile.version", "short": "Business version of the expansion profile", "definition": "The identifier that is used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile 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 expansion profile instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the expansion profile with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.name", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.name", "path": "ExpansionProfile.name", "short": "Name for this expansion profile (computer friendly)", "definition": "A natural language name identifying the expansion profile. 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.status", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.status", "path": "ExpansionProfile.status", "short": "draft | active | retired | unknown", "definition": "The status of this expansion profile. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of expansion profiles that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired expansion profile without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.experimental", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.experimental", "path": "ExpansionProfile.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this expansion profile is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of expansion profile that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental expansion profile in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level expansion profile.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.date", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.date", "path": "ExpansionProfile.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the expansion profile was published. The date must change if and 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 expansion profile 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 expansion profile. 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" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.publisher", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.publisher", "path": "ExpansionProfile.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the expansion profile.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the expansion profile is the organization or individual primarily responsible for the maintenance and upkeep of the expansion profile. 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 expansion profile. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the expansion profile. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.contact", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.contact", "path": "ExpansionProfile.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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.description", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.description", "path": "ExpansionProfile.description", "short": "Natural language description of the expansion profile", "definition": "A free text natural language description of the expansion profile from a consumer's perspective.", "comment": "This description can be used to capture details such as why the expansion profile 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 expansion profile 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.useContext", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.useContext", "path": "ExpansionProfile.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate expansion profile instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.jurisdiction", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.jurisdiction", "path": "ExpansionProfile.jurisdiction", "short": "Intended jurisdiction for expansion profile (if applicable)", "definition": "A legal or geographic region in which the expansion profile is intended to be used.", "comment": "It may be possible for the expansion profile to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.fixedVersion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.fixedVersion", "path": "ExpansionProfile.fixedVersion", "short": "Fix use of a code system to a particular version", "definition": "Fix use of a particular code system to a particular version.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion.system", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.fixedVersion.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.fixedVersion.system", "path": "ExpansionProfile.fixedVersion.system", "short": "System to have its version fixed", "definition": "The specific system for which to fix the version.", "comment": "See ''Coding.system'' for further documentation.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion.version", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.fixedVersion.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.fixedVersion.version", "path": "ExpansionProfile.fixedVersion.version", "short": "Specific version of the code system referred to", "definition": "The version of the code system from which codes in the expansion should be included.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion.mode", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.fixedVersion.mode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.fixedVersion.mode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.fixedVersion.mode", "path": "ExpansionProfile.fixedVersion.mode", "short": "default | check | override", "definition": "How to manage the intersection between a fixed version in a value set, and this fixed version of the system in the expansion profile.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SystemVersionProcessingMode" } ], "strength": "required", "description": "How to manage the intersection between a fixed version in a value set, and a fixed version of the system in the expansion profile", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/system-version-processing-mode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludedSystem", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.excludedSystem", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludedSystem", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.excludedSystem", "path": "ExpansionProfile.excludedSystem", "short": "Systems/Versions to be exclude", "definition": "Code system, or a particular version of a code system to be excluded from value set expansions.", "comment": "When a system is excluded, and this makes a material difference to the expansion, the exclusion SHALL be noted in the expansion parameters using a parameter 'excluded'.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludedSystem.system", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.excludedSystem.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludedSystem.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.excludedSystem.system", "path": "ExpansionProfile.excludedSystem.system", "short": "The specific code system to be excluded", "definition": "An absolute URI which is the code system to be excluded.", "comment": "See ''Coding.system'' for further documentation.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludedSystem.version", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.excludedSystem.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludedSystem.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.excludedSystem.version", "path": "ExpansionProfile.excludedSystem.version", "short": "Specific version of the code system referred to", "definition": "The version of the code system from which codes in the expansion should be excluded.", "comment": "This is used to apply version specifc exclusion contraints. If no version is specified, then all codes from the code system present in the expansion (prior to application of the expansion profile) will be excluded.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "meaningWhenMissing": "Exclusion is not version specific", "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.includeDesignations", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.includeDesignations", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.includeDesignations", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.includeDesignations", "path": "ExpansionProfile.includeDesignations", "short": "Whether the expansion should include concept designations", "definition": "Controls whether concept designations are to be included or excluded in value set expansions.", "comment": "ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are only evaluated if includeDesignations is present and set to \"true\". If includeDesignations is present with a value of \"true\" and both ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are absent, then all designations are returned in the expansion.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation", "path": "ExpansionProfile.designation", "short": "When the expansion profile imposes designation contraints", "definition": "A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.include", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.include", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "DesignationInclude" } ], "path": "ExpansionProfile.designation.include", "short": "Designations to be included", "definition": "Designations to be included.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include.designation", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.include.designation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include.designation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.include.designation", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "DesignationIncludeDesignation" } ], "path": "ExpansionProfile.designation.include.designation", "short": "The designation to be included", "definition": "A data group for each designation to be included.", "comment": "At least one of designation.language or designation.use must be provided for each include.designation element.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "exp-3", "severity": "error", "human": "SHALL have at least one of language or use", "expression": "language.exists() or use.exists()", "xpath": "exists(f:language) or exists(f:use)" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include.designation.language", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.include.designation.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include.designation.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.include.designation.language", "path": "ExpansionProfile.designation.include.designation.language", "short": "Human language of the designation to be included", "definition": "The language this designation is defined for.", "comment": "In the absence of a language, all designations are retained which match the designation.use parameter for this include.designation.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include.designation.use", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.include.designation.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.include.designation.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.include.designation.use", "path": "ExpansionProfile.designation.include.designation.use", "short": "What kind of Designation to include", "definition": "Which kinds of designation to include in the expansion.", "comment": "In the absence of a use, all designations are retained which match the designation.language parameter for this include.designation element.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConceptDesignationUse" } ], "strength": "required", "description": "Details of how a designation would be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/designation-use" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.exclude", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.exclude", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "DesignationExclude" } ], "path": "ExpansionProfile.designation.exclude", "short": "Designations to be excluded", "definition": "Designations to be excluded.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude.designation", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.exclude.designation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude.designation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.exclude.designation", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "DesignationExcludeDesignation" } ], "path": "ExpansionProfile.designation.exclude.designation", "short": "The designation to be excluded", "definition": "A data group for each designation to be excluded.", "comment": "At least one of designation.language or designation.use must be provided for each exclude.designation element.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "exp-4", "severity": "error", "human": "SHALL have at least one of language or use", "expression": "language.exists() or use.exists()", "xpath": "exists(f:language) or exists(f:use)" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude.designation.language", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.exclude.designation.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude.designation.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.exclude.designation.language", "path": "ExpansionProfile.designation.exclude.designation.language", "short": "Human language of the designation to be excluded", "definition": "The language this designation is defined for.", "comment": "In the absence of a language, all designations are excluded which match the designation.use parameter for this exclude.designation element.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude.designation.use", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.designation.exclude.designation.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.designation.exclude.designation.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.designation.exclude.designation.use", "path": "ExpansionProfile.designation.exclude.designation.use", "short": "What kind of Designation to exclude", "definition": "Which kinds of designation to exclude from the expansion.", "comment": "In the absence of a use, all designations are retained which match the designation.language parameter for this exclude.designation element.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConceptDesignationUse" } ], "strength": "required", "description": "Details of how a designation would be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/designation-use" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.includeDefinition", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.includeDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.includeDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.includeDefinition", "path": "ExpansionProfile.includeDefinition", "short": "Include or exclude the value set definition in the expansion", "definition": "Controls whether the value set definition is included or excluded in value set expansions.", "comment": "The ValueSet defintion refers to all fields in the ValueSet definition apart from ValueSet.contains. The definition is only included if includeDefinition is present and has a value of \"true\".", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.activeOnly", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.activeOnly", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.activeOnly", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.activeOnly", "path": "ExpansionProfile.activeOnly", "short": "Include or exclude inactive concepts in the expansion", "definition": "Controls whether inactive concepts are included or excluded in value set expansions.", "comment": "Inactive codes are included if activeOnly is present and has a value of \"true\". Note that if the value set explicitly specifies that inactive codes are included, this property can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludeNested", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.excludeNested", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludeNested", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.excludeNested", "path": "ExpansionProfile.excludeNested", "short": "Nested codes in the expansion or not", "definition": "Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).", "comment": "Nesting of codes is excluded if excludeNested is present and has a value of \"true\".", "requirements": "Heirahical contains are useful for UI use, but not when validating. Code Generation etc. may depend on context.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludeNotForUI", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.excludeNotForUI", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludeNotForUI", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.excludeNotForUI", "path": "ExpansionProfile.excludeNotForUI", "short": "Include or exclude codes which cannot be rendered in user interfaces in the value set expansion", "definition": "Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.", "comment": "Codes which cannot be used in user interfaces will be excluded if excludeNotForUI is present and has a value of \"true\".", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludePostCoordinated", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.excludePostCoordinated", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.excludePostCoordinated", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.excludePostCoordinated", "path": "ExpansionProfile.excludePostCoordinated", "short": "Include or exclude codes which are post coordinated expressions in the value set expansion", "definition": "Controls whether or not the value set expansion includes post coordinated codes.", "comment": "Post coordinated codes are excluded if excludePostCoordinated is present and has a value of \"true\".", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.displayLanguage", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.displayLanguage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.displayLanguage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.displayLanguage", "path": "ExpansionProfile.displayLanguage", "short": "Specify the language for the display element of codes in the value set expansion", "definition": "Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExpansionProfile.limitedExpansion", "resource": { "resourceType": "DataElement", "id": "ExpansionProfile.limitedExpansion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExpansionProfile.limitedExpansion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExpansionProfile.limitedExpansion", "path": "ExpansionProfile.limitedExpansion", "short": "Controls behaviour of the value set expand operation when value sets are too large to be completely expanded", "definition": "If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).", "comment": "This field overides the default behaviour (which is to return an error). This does not apply to expansions which are unbounded. Clients SHALL process the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html) correctly if limitedExpansion = true.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot", "resource": { "resourceType": "DataElement", "id": "Slot", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot", "path": "Slot", "short": "A slot of time on a schedule that may be available for booking appointments", "definition": "A slot of time on a schedule that may be available for booking appointments.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" }, { "identity": "ical", "map": "(refer to the Availability resource for the header mapping details)" }, { "identity": "w5", "map": "workflow.scheduling" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.identifier", "resource": { "resourceType": "DataElement", "id": "Slot.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.identifier", "path": "Slot.identifier", "short": "External Ids for this item", "definition": "External Ids for this item.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.serviceCategory", "resource": { "resourceType": "DataElement", "id": "Slot.serviceCategory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.serviceCategory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.serviceCategory", "path": "Slot.serviceCategory", "short": "A broad categorisation of the service that is to be performed during this appointment", "definition": "A broad categorisation of the service that is to be performed during this appointment.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-category" } ], "strength": "example", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-category" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.serviceType", "resource": { "resourceType": "DataElement", "id": "Slot.serviceType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.serviceType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.serviceType", "path": "Slot.serviceType", "short": "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource", "definition": "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-type" } ], "strength": "example", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-type" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.specialty", "resource": { "resourceType": "DataElement", "id": "Slot.specialty", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.specialty", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.specialty", "path": "Slot.specialty", "short": "The specialty of a practitioner that would be required to perform the service requested in this appointment", "definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "specialty" } ], "strength": "preferred", "description": "Additional details about where the content was created (e.g. clinical specialty).", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.appointmentType", "resource": { "resourceType": "DataElement", "id": "Slot.appointmentType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.appointmentType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.appointmentType", "path": "Slot.appointmentType", "short": "The style of appointment or patient that may be booked in the slot (not service type)", "definition": "The style of appointment or patient that may be booked in the slot (not service type).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "appointment-type" } ], "strength": "preferred", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0276" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.schedule", "resource": { "resourceType": "DataElement", "id": "Slot.schedule", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.schedule", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.schedule", "path": "Slot.schedule", "short": "The schedule resource that this slot defines an interval of status information", "definition": "The schedule resource that this slot defines an interval of status information.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Schedule" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.status", "resource": { "resourceType": "DataElement", "id": "Slot.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.status", "path": "Slot.status", "short": "busy | free | busy-unavailable | busy-tentative | entered-in-error", "definition": "busy | free | busy-unavailable | busy-tentative | entered-in-error.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SlotStatus" } ], "strength": "required", "description": "The free/busy status of the slot.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/slotstatus" } }, "mapping": [ { "identity": "ical", "map": "FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.start", "resource": { "resourceType": "DataElement", "id": "Slot.start", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.start", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.start", "path": "Slot.start", "short": "Date/Time that the slot is to begin", "definition": "Date/Time that the slot is to begin.", "min": 1, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "ical", "map": "FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded" }, { "identity": "w5", "map": "when.planned" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.end", "resource": { "resourceType": "DataElement", "id": "Slot.end", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.end", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.end", "path": "Slot.end", "short": "Date/Time that the slot is to conclude", "definition": "Date/Time that the slot is to conclude.", "min": 1, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "ical", "map": "FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)" }, { "identity": "w5", "map": "when.planned" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.overbooked", "resource": { "resourceType": "DataElement", "id": "Slot.overbooked", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.overbooked", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.overbooked", "path": "Slot.overbooked", "short": "This slot has already been overbooked, appointments are unlikely to be accepted for this time", "definition": "This slot has already been overbooked, appointments are unlikely to be accepted for this time.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "meaningWhenMissing": "If overbooked is missing, systems may assume that there are still appointments available" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Slot.comment", "resource": { "resourceType": "DataElement", "id": "Slot.comment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Slot.comment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Slot.comment", "path": "Slot.comment", "short": "Comments on the slot to describe any extended information. Such as custom constraints on the slot", "definition": "Comments on the slot to describe any extended information. Such as custom constraints on the slot.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person", "resource": { "resourceType": "DataElement", "id": "Person", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person", "path": "Person", "short": "A generic person record", "definition": "Demographics and administrative information about a person independent of a specific health-related context.", "comment": "The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")" }, { "identity": "w5", "map": "administrative.entity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.identifier", "resource": { "resourceType": "DataElement", "id": "Person.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.identifier", "path": "Person.identifier", "short": "A human identifier for this person", "definition": "Identifier for a person within a particular scope.", "requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".plays:Role(classCode='IDENT').id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.name", "resource": { "resourceType": "DataElement", "id": "Person.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.name", "path": "Person.name", "short": "A name associated with the person", "definition": "A name associated with the person.", "comment": "Person may have multiple names with different uses or applicable periods.", "requirements": "Need to be able to track the person by multiple names. Examples are your official name and a partner name.", "min": 0, "max": "*", "type": [ { "code": "HumanName" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "./name" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.telecom", "resource": { "resourceType": "DataElement", "id": "Person.telecom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.telecom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.telecom", "path": "Person.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": "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 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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-13, PID-14" }, { "identity": "rim", "map": "./telecom" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.gender", "resource": { "resourceType": "DataElement", "id": "Person.gender", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.gender", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.gender", "path": "Person.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender.", "comment": "The gender may 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 M and F, though the vast majority of systems and contexts only support M and F.", "requirements": "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/administrative-gender" } }, "mapping": [ { "identity": "v2", "map": "PID-8" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.birthDate", "resource": { "resourceType": "DataElement", "id": "Person.birthDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.birthDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.birthDate", "path": "Person.birthDate", "short": "The date on which the person was born", "definition": "The birth date for the person.", "comment": "At least an estimated year should be provided as a guess if the real DOB is unknown.", "requirements": "Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-7" }, { "identity": "rim", "map": "./birthTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.address", "resource": { "resourceType": "DataElement", "id": "Person.address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.address", "path": "Person.address", "short": "One or more addresses for the person", "definition": "One or more addresses for the person.", "comment": "Person may have multiple addresses with different uses or applicable periods.", "requirements": "May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.", "min": 0, "max": "*", "type": [ { "code": "Address" } ], "mapping": [ { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "./addr" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.photo", "resource": { "resourceType": "DataElement", "id": "Person.photo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.photo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.photo", "path": "Person.photo", "short": "Image of the person", "definition": "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.", "min": 0, "max": "1", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "v2", "map": "OBX-5 - needs a profile" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.managingOrganization", "resource": { "resourceType": "DataElement", "id": "Person.managingOrganization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.managingOrganization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.managingOrganization", "path": "Person.managingOrganization", "short": "The organization that is the custodian of the person record", "definition": "The organization that is the custodian of the person record.", "requirements": "Need to know who recognizes this person record, manages and updates it.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.active", "resource": { "resourceType": "DataElement", "id": "Person.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.active", "path": "Person.active", "short": "This person's record is in active use", "definition": "Whether this person's record is in active use.", "requirements": "Need to be able to mark a person record as not to be used because it was created in error.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.link", "resource": { "resourceType": "DataElement", "id": "Person.link", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.link", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.link", "path": "Person.link", "short": "Link to a resource that concerns the same actual person", "definition": "Link to a resource that concerns the same actual person.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "outboundLink" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.link.target", "resource": { "resourceType": "DataElement", "id": "Person.link.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.link.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.link.target", "path": "Person.link.target", "short": "The resource to which this actual person is associated", "definition": "The resource to which this actual person is associated.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Person" } ], "mapping": [ { "identity": "rim", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Person.link.assurance", "resource": { "resourceType": "DataElement", "id": "Person.link.assurance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Person.link.assurance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Person.link.assurance", "path": "Person.link.assurance", "short": "level1 | level2 | level3 | level4", "definition": "Level of assurance that this link is actually associated with the target resource.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentityAssuranceLevel" } ], "strength": "required", "description": "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identity-assuranceLevel" } }, "mapping": [ { "identity": "rim", "map": "priorityNumber?" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract", "resource": { "resourceType": "DataElement", "id": "Contract", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract", "path": "Contract", "short": "Legal Agreement", "definition": "A formal agreement between parties regarding the conduct of business, exchange of information or other matters.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "rim", "map": "FinancialContract" }, { "identity": "w5", "map": "financial.other" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.identifier", "resource": { "resourceType": "DataElement", "id": "Contract.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.identifier", "path": "Contract.identifier", "short": "Contract number", "definition": "Unique identifier for this Contract.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "rim", "map": "FinancialContract id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.status", "resource": { "resourceType": "DataElement", "id": "Contract.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.status", "path": "Contract.status", "short": "amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated", "definition": "The status of the resource instance.", "comment": "This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractStatus" } ], "strength": "required", "description": "A code specifying the state of the resource instance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.issued", "resource": { "resourceType": "DataElement", "id": "Contract.issued", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.issued", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.issued", "path": "Contract.issued", "short": "When this Contract was issued", "definition": "When this Contract was issued.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence" }, { "identity": "rim", "map": "Act.availabilityTime. Definition: A time expression specifying when an Observation, Procedure, or other Act occurs, or, depending on the mood, is supposed to occur, scheduled to occur, etc. The activityTime includes the times of component actions (such as preparation and clean-up). For Procedures and SubstanceAdministrations, the activityTime can provide a needed administrative function by providing a more inclusive time to be anticipated in scheduling. UsageNotes:The activityTime is primarily of administrative rather than clinical use. The clinically relevant time is the effectiveTime. When an observation of a prior symptom is made, the activityTime describes the time the observation is made, as opposed to effectiveTime which is the time the symptom is reported to have occurred. Thus the activityTime may be entirely different from the effectiveTime of the same Act. However, even apart from clinical use cases, designers should first consider effectiveTime as the primary relevant time for an Act. ActivityTime indicates when an Act occurs, not when it is recorded." }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.applies", "resource": { "resourceType": "DataElement", "id": "Contract.applies", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.applies", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.applies", "path": "Contract.applies", "short": "Effective time", "definition": "Relevant time or time-period when this Contract is applicable.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Act.effectiveTime Definition: The clinically or operationally relevant time of an act, exclusive of administrative activity." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.subject", "resource": { "resourceType": "DataElement", "id": "Contract.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.subject", "path": "Contract.subject", "short": "Contract Target Entity", "definition": "The target entity impacted by or of interest to parties to the agreement.", "comment": "The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason. \rIn many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement.", "requirements": "The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason. In many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement.", "alias": [ "Patient" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "rim", "map": "RoleClass, RoleCode" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.topic", "resource": { "resourceType": "DataElement", "id": "Contract.topic", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.topic", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.topic", "path": "Contract.topic", "short": "Context of the Contract", "definition": "The matter of concern in the context of this agreement.", "comment": "The Contract.topic may be an application for or offer of a policy or service (e.g., uri to a consent directive form or a health insurance policy), which becomes the Contract once accepted by both the grantor and grantee. \rThe Contract Resource may function simply as the computable representation of the executed contract, which may be the attached to the Contract Resource as the “binding” or as the “friendly” electronic form. For example, a Contract Resource may be automatically populated with the values expressed in a related QuestionnaireResponse. \rHowever, the Contract Resource may be considered the legally binding contract if it is the only “executed” form of this contract, and includes the signatures as *The Contract Resource may function as the computable representation of an application or offer in a pre-executed Contract if the grantor has not entered any values. In this case, it is populated with values in a “legal” form of the application or offer or by the values in an associated Questionnaire. If the grantor has filled in the legal form or the associated Questionnaire Response, then these values are used to populate a pre-executed Contract Resource.\rIf the Contract.topic is considered an application or offer, then the policy is often required to be attached as the “legal” basis for the application to ensure “informed consent” to the contract, and that any discrepancy between the application and the policy are interpreted against the policy. Implementers should check organizational and jurisdictional policies to determine the relationship among multiple representations of a contract pre- and post-execution.", "requirements": "In the context of a contract, the topic is the matter under consideration in regards to which specific rights, privileges, obligations, restrictions, and prohibitions are binding on any grantor and grantee parties upon the execution of the contract. \rGiven the wide range of contract topics, implementers need to be cognizant of the business use case for which they are designing a FHIR Contract, and narrowly specify the topic being represented with respect to the Contract.type and any specializing Contract.subtype. \rThe same topic, e.g., an asset such as a good or service, such as a real property, medical supply, insurance, information, a procedure or employment, or a manner of conduct, such adherence to a privacy, trust, or security policy, may be the topic of multiple types of contracts. \rOne way to determine the Contract.topic is to answer the question: “What is the object of negotiation?”\rAnswer: The Contract.topic, which may be described with more detail in the [0..*]Contract.valuedItem @ [0..1] Contract.valuedItem.entity[x] Definition: Specific type of Contract Valued Item that may be priced. CodeableConcept|Reference(Any)\rContract.topic is “the what” that a grantor is exchanging with a grantee in return for some benefit. \rContract.topic is “the what” to which any Contract.action is being applied for any stipulated Contract.action.reason. \rAContract.topic is “the what” governed by the execution of the contract to which any party’s rights, privileges, obligations, restrictions, and prohibitions apply.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "rim", "map": "Includes many ActClass, ActCode, RoleClass, RoleCode, EntityClass, EntityCode, ParticipationType codes from HL7 concept domains and code systems. For example, RoleCode: HLD (held entity) Description: Entity that is currently in the possession of a holder (scoper), who holds, or uses it, usually based on some agreement with the owner. MANU (manufactured product) Description: Scoped by the manufacturer. OWN (owned entity) Description: An Entity (player) for which someone (scoper) is granted by law the right to call the material (player) his own. This entitles the scoper to make decisions about the disposition of that material. WRTE (warranted product) Description:\rA role a product plays when a guarantee is given to the purchaser by the seller (scoping entity) stating that the product is reliable and free from known defects and that the seller will repair or replace defective parts within a given time limit and under certain conditions." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.authority", "resource": { "resourceType": "DataElement", "id": "Contract.authority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.authority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.authority", "path": "Contract.authority", "short": "Authority under which this Contract has standing", "definition": "A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": "Organization Role. CONCEPT DOMAIN: OrganizationEntityType Description: Further classifies entities of EntityClass ORG." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.domain", "resource": { "resourceType": "DataElement", "id": "Contract.domain", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.domain", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.domain", "path": "Contract.domain", "short": "Domain in which this Contract applies", "definition": "Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.", "alias": [ "scope of governance jurisdiction" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "rim", "map": "TERR (territory of authority) Description: Relates a place entity (player) as the region over which the scoper (typically an Organization) has certain authority (jurisdiction). For example, the Calgary Regional Health Authority (scoper) has authority over the territory \"Region 4 of Alberta\" (player) in matters of health.\rEntity Class = Place? A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place may or may not be constant.\rCONCEPT DOMAIN: TerritoryEntityType Description: A territorial entity that may be cited as the body over which an agency exercises jurisdiction, or which defines a sphere in which a party has a particular responsibility. CONCEPT DOMAIN: OrganizationEntityType\rDescription: Further classifies entities of EntityClass ORG." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.type", "resource": { "resourceType": "DataElement", "id": "Contract.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.type", "path": "Contract.type", "short": "Type or form", "definition": "Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractType" } ], "strength": "example", "description": "List of overall contract codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-type" } }, "mapping": [ { "identity": "rim", "map": "Maps to multiple ActClass and ActCode Concept Domains and Code Systems such as the following: In the ActClass Concept Domain: ActClassPolicy. In the ActCode Concept Domain: ActContractType, which generalizes ActFinancialContractType, ActCoverageType, ActBillingArrangementType. ActConsentType, which generalizes ActDataConsentType; ActFinancialParticipationConsentType; ActInformationAccessCode; AdvanceBeneficiaryNoticeType. ActPolicyType, which generalizes: ActPrivacyPolicyType, ActSensitivityPrivacyPolicyType, ActSecurityPolicyType. In the ActClass Code System: CNTRCT (contract) Description: An agreement of obligation between two or more parties that is subject to contractual law and enforcement, lwhich generalizes FCNTRCT (financial contract) and COV (coverage). POLICY (policy) - Description: A mandate, regulation, obligation, requirement, rule, or expectation unilaterally imposed by one party on: The activity of another party; the behavior of another party; or the manner in which an act is executed. LEAF CONCEPTS: JURISPOL (jurisdictional policy) Description:A mandate, regulation, obligation, requirement, rule, or expectation unilaterally imposed by a jurisdiction on: The activity of another party; the behavior of another party; or the manner in which an act is executed.Examples:A jurisdictional mandate regarding the prescribing and dispensing of a particular medication. A jurisdictional privacy or security regulation dictating the manner in which personal health information is disclosed. A jurisdictional requirement that certain services or health conditions are reported to a monitoring program, e.g., immunizations, methadone treatment, or cancer registries.ORGPOL (organizational policy)Examples:A clinical or research protocols imposed by a payer, a malpractice insurer, or an institution to which a provider must adhere. A mandate imposed by a denominational institution for a provider to provide or withhold certain information from the patient about treatment options.SCOPOL (scope of practice policy)Description:An ethical or clinical obligation, requirement, rule, or expectation imposed or strongly encouraged by organizations that oversee particular clinical domains or provider certification which define the boundaries within which a provider may practice and which may have legal basis or ramifications.Examples:An ethical obligation for a provider to fully inform a patient about all treatment options. An ethical obligation for a provider not to disclose personal health information that meets certain criteria, e.g., where disclosure might result in harm to the patient or another person. The set of health care services which a provider is credentialed or privileged to provide. STDPOL (standard of practice policy) Examples:A payer may require a prescribing provider to adhere to formulary guidelines. An institution may adopt clinical guidelines and protocols and implement these within its electronic health record and decision support systems. CONS (consent)Description: The Consent class represents informed consents and all similar medico-legal transactions between the patient (or his legal guardian) and the provider. Examples are informed consent for surgical procedures, informed consent for clinical trials, advanced beneficiary notice, against medical advice decline from service, release of information agreement, etc. The details of consents vary. Often an institution has a number of different consent forms for various purposes, including reminding the physician about the topics to mention. Such forms also include patient education material. In electronic medical record communication, consents thus are information-generating acts on their own and need to be managed similar to medical activities. Thus, Consent is modeled as a special class of Act. The \"signatures\" to the consent document are represented electronically through Participation instances to the consent object. Typically an informed consent has Participation.typeCode of \"performer\", the healthcare provider informing the patient, and \"consenter\", the patient or legal guardian. Some consent may associate a witness or a notary public (e.g., living wills, advanced directives). In consents where a healthcare provider is not required (e.g. living will), the performer may be the patient himself or a notary public." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.subType", "resource": { "resourceType": "DataElement", "id": "Contract.subType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.subType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.subType", "path": "Contract.subType", "short": "Subtype within the context of type", "definition": "More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractSubtype" } ], "strength": "example", "description": "Detailed codes within the above.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-subtype" } }, "mapping": [ { "identity": "rim", "map": "Examples of Contract or Policy subtypes in ActCodes:_ActCoverageTypeCode Definition: Set of codes indicating the type of insurance policy or program that pays for the cost of benefits provided to covered parties. Generalizes: _ActInsurancePolicyCode; _ActInsuranceTypeCode; ActProgramTypeCode. _ActPolicyType Description:Types of policies that further specify the ActClassPolicy value set. Generalizes: _ActPrivacyPolicy; _ActPrivacyLaw; _InformationSensitivityPolicy; ActTrustPolicyType; SecurityPolicy. _ActInvoiceAdjudicationPaymentGroupCode Description: Codes representing adjustments to a Payment Advice such as retroactive, clawback, garnishee, etc., e.g. RECOV (recovery) Description: Retroactive adjustment such as fee rate adjustment due to contract negotiations." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.action", "resource": { "resourceType": "DataElement", "id": "Contract.action", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.action", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.action", "path": "Contract.action", "short": "Action stipulated by this Contract", "definition": "Action stipulated by this Contract.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractAction" } ], "strength": "example", "description": "Detailed codes for the contract action.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-action" } }, "mapping": [ { "identity": "rim", "map": "Maps to multiple ActClass and ActCode Concept Domains and Code Systems." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.actionReason", "resource": { "resourceType": "DataElement", "id": "Contract.actionReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.actionReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.actionReason", "path": "Contract.actionReason", "short": "Rationale for the stiplulated action", "definition": "Reason for action stipulated by this Contract.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractActionReason" } ], "strength": "example", "description": "Detailed codes for the contract action reason.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse" } }, "mapping": [ { "identity": "rim", "map": "Examples from ActReason Concept Domains: ActCoverageReason Description:Codes used to specify reasons or criteria relating to coverage provided under a policy or program. May be used to convey reasons pertaining to coverage contractual provisions, including criteria for eligibility, coverage limitations, coverage maximums, or financial participation required of covered parties. ActInformationPrivacyReason Description: The rationale or purpose for an act relating to the management of personal information, such as disclosing personal tax information for the purpose of complying with a court order. ClinicalResearchObservationReason Definition: Specifies the reason that a test was performed or observation collected in a clinical research study. SafetyInvestigationReportReasonType Description: Possible reasons generating a report providing information developed during the investigation of an adverse event or a product problem. ControlActReason Description: Indicates the motivation, cause or rationale of an Act which results in a trigger event. NonPerformanceReasonCode Description: The reason the action was not performed, e.g. why the medication was not taken. If an action was not performed, it is often clinically important to know why the action was not taken. RefusalReasonCode Description: Identifies why a request to add (or activate) a record is being refused. Examples include the receiving system not able to match the identifier and find that record in the receiving system, having no permission, or a detected issue exists which precludes the requested action.\r\r\r\r\r\r\r\rExamples from HL7 ActReason Code System: QUALIMP (quality improvement) Description:Operational activities conducted for the purposes of improving the quality of an activity, product, or service. _PatientProfileQueryReasonCode Description: A collection of concepts identifying why the patient's profile is being queried. _ActInformationManagementReason Description:The rationale or purpose for an act relating to information management, such as archiving information for the purpose of complying with an enterprise data retention policy. _ActInvalidReason (ActInvalidReason) Description: Types of reasons why a substance is invalid for use. _NonPerformanceReasonCode Description: The reason the action wasn't performed, e.g. why the medication was not taken. If an action wasn\"t performed, it is often clinically important to know why the action wasn\"t taken." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.decisionType", "resource": { "resourceType": "DataElement", "id": "Contract.decisionType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.decisionType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.decisionType", "path": "Contract.decisionType", "short": "Decision by Grantor", "definition": "The type of decision made by a grantor with respect to an offer made by a grantee.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractDecisionType" } ], "strength": "extensible", "description": "The type of decision made by a grantor with respect to an offer made by a grantee.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActConsentDirective" } }, "mapping": [ { "identity": "rim", "map": "ActCode: _ActConsentDirective [abstract term] Description: Specifies the type of agreement between one or more grantor and grantee in which rights and obligations related to one or more shared items of interest are allocated. Usage Note: Such agreements may be considered \"consent directives\" or \"contracts\" depending on the context, and are considered closely related or synonymous from a legal perspective." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.contentDerivative", "resource": { "resourceType": "DataElement", "id": "Contract.contentDerivative", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.contentDerivative", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.contentDerivative", "path": "Contract.contentDerivative", "short": "Content derived from the basal information", "definition": "The minimal content derived from the basal information source at a specific stage in its lifecycle.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractContentDerivative" } ], "strength": "example", "description": "This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-content-derivative" } }, "mapping": [ { "identity": "rim", "map": "Maps partially to several v3 codes: ActClass: REG (registration) Description: Represents the act of maintaining information about the registration of its associated registered subject. The subject can be either an Act or a Role, and includes subjects such as lab exam definitions, drug protocol definitions, prescriptions, persons, patients, practitioners, and equipment.\rThe registration may have a unique identifier - separate from the unique identification of the subject - as well as a core set of related participations and act relationships that characterize the registration event and aid in the disposition of the subject information by a receiving system. Observation: VERIF (Verification) Description: An act which describes the process whereby a 'verifying party' validates either the existence of the Role attested to by some Credential or the actual Vetting act and its details. TRFR (transfer) Description: The act of transferring information without the intent of imparting understanding about a topic to the subject that is the recipient or holder of the transferred information where the participation association must be RCV or HLD. _ActDetectedIssueManagementCode [abstract term] Description: Codes dealing with the management of Detected Issue observations. _ActInformationAccessContextCode [abstract term] Description: Concepts conveying the context in which authorization given under jurisdictional law, by organizational policy, or by a patient consent directive permits the collection, access, use or disclosure of specified patient health information. _ActListCode [abstract term]vDescription: Provides codes associated with ActClass value of LIST (working list). RefusalReasonCode [abstract term] Description:\rDescription: Identifies why a request to add (or activate) a record is being refused. Examples include the receiving system not able to match the identifier and find that record in the receiving system, having no permission, or a detected issue exists which precludes the requested action." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.securityLabel", "resource": { "resourceType": "DataElement", "id": "Contract.securityLabel", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.securityLabel", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.securityLabel", "path": "Contract.securityLabel", "short": "Security Labels that define affected resources", "definition": "A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } }, "mapping": [ { "identity": "rim", "map": "ActCode ObservationType:SECOBS [abstract term]\rDescription: An observation identifying security metadata about an IT resource (data, information object, service, or system capability), which may be used to make access control decisions. Security metadata are used to name security labels. \rRationale: According to ISO/TS 22600-3:2009(E) A.9.1.7 SECURITY LABEL MATCHING, Security label matching compares the initiator's clearance to the target's security label. All of the following must be true for authorization to be granted:\rThe security policy identifiers shall be identical. The classification level of the initiator shall be greater than or equal to that of the target (that is, there shall be at least one value in the classification list of the clearance greater than or equal to the classification of the target), and For each security category in the target label, there shall be a security category of the same type in the initiator's clearance and the initiator's classification level shall dominate that of the target. Examples: SecurityObservationType security label fields include: Confidentiality classification; Compartment category; Sensitivity category\rSecurity mechanisms used to ensure data integrity or to perform authorized data transformation Indicators of an IT resource completeness, veracity, reliability, trustworthiness, or provenance. Usage Note: SecurityObservationType codes designate security label field types, which are valued with an applicable SecurityObservationValue code as the \"security label tag\". _SecurityObservationValue [abstract term] Description: Observation values used to indicate security observation metadata." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.agent", "resource": { "resourceType": "DataElement", "id": "Contract.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.agent", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Agent" } ], "path": "Contract.agent", "short": "Entity being ascribed responsibility", "definition": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.", "comment": "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.\rFor example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, software, or system process. However, only one user may be the initiator/requestor for the event.", "requirements": "An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.agent.actor", "resource": { "resourceType": "DataElement", "id": "Contract.agent.actor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.agent.actor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.agent.actor", "path": "Contract.agent.actor", "short": "Contract Agent Type", "definition": "Who or what parties are assigned roles in this Contract.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Contract" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "rim", "map": "RIM Role, Participation Type classes" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.agent.role", "resource": { "resourceType": "DataElement", "id": "Contract.agent.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.agent.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.agent.role", "path": "Contract.agent.role", "short": "Role type of the agent", "definition": "Role type of agent assigned roles in this Contract.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractActorRole" } ], "strength": "example", "description": "Detailed codes for the contract actor role.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-actorrole" } }, "mapping": [ { "identity": "rim", "map": "RoleClass, RoleCode, ParticipationType, ParticipationFunction codes" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.signer", "resource": { "resourceType": "DataElement", "id": "Contract.signer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.signer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.signer", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Signatory" } ], "path": "Contract.signer", "short": "Contract Signatory", "definition": "Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.", "comment": "Signers who are principal parties to the contract are bound by the Contract.activity related to the Contract.topic, and the Contract.term(s), which either extend or restrict the overall action on the topic by, for example, stipulating specific policies or obligations constraining actions, action reason, or agents with respect to some or all of the topic.\rFor example, specifying how policies or obligations shall constrain actions and action reasons permitted or denied on all or a subset of the Contract.topic (e.g., all or a portion of property being transferred by the contract), agents (e.g., who can resell, assign interests, or alter the property being transferred by the contract), actions, and action reasons; or with respect to Contract.terms, stipulating, extending, or limiting the Contract.period of applicability or valuation of items under consideration.", "requirements": "The Contract.signer applies a signature to the Contract.binding referenced resource, which is the documentation that is the legal \"source of truth\". The Contract.signer may delegate, such as a legally recognized personal representative, or have a delegate assigned e.g., by a court of law, to actually sign the Contract, such as a trustee in the case of incompetence.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.signer.type", "resource": { "resourceType": "DataElement", "id": "Contract.signer.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.signer.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.signer.type", "path": "Contract.signer.type", "short": "Contract Signatory Role", "definition": "Role of this Contract signer, e.g. notary, grantee.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractSignerType" } ], "strength": "preferred", "description": "List of parties who may be signing.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-signer-type" } }, "mapping": [ { "identity": "rim", "map": "RoleClass, RoleCode, ParticipationType, ParticipationFunction class codes." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.signer.party", "resource": { "resourceType": "DataElement", "id": "Contract.signer.party", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.signer.party", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.signer.party", "path": "Contract.signer.party", "short": "Contract Signatory Party", "definition": "Party which is a signator to this Contract.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "mapping": [ { "identity": "rim", "map": "Role Class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.signer.signature", "resource": { "resourceType": "DataElement", "id": "Contract.signer.signature", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.signer.signature", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.signer.signature", "path": "Contract.signer.signature", "short": "Contract Documentation Signature", "definition": "Legally binding Contract DSIG signature contents in Base64.", "min": 1, "max": "*", "type": [ { "code": "Signature" } ], "mapping": [ { "identity": "rim", "map": "Participation.signatureCode :: CD (0..1) Definition: Whether the participant has attested participation through a signature, or whether such a signature is needed. Examples: A surgical Procedure act object (representing a procedure report) requires a signature of the performing and responsible surgeon, and possibly other participants; The participant intends to provide a signature. Participation.signatureText :: ED (0..1) Definition: A textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. UsageNotes: The signature can be represented either inline or by reference according to the ED data type. Typical cases are \r1) Paper-based signatures: the ED data type may refer to a document or other resource that can be retrieved through an electronic interface to a hardcopy archive. 2) Electronic signature: this attribute can represent virtually any electronic signature scheme. 3) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. Examples: 1) An \"author\" participant assumes accountability for the truth of the Act statement to the best of his knowledge. 2) An information recipient only attests to the fact that he or she has received the information." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ValuedItem" } ], "path": "Contract.valuedItem", "short": "Contract Valued Item List", "definition": "Contract Valued Item List.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem classCode INVE" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.entityX", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.entityX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.entityX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.entity[x]", "path": "Contract.valuedItem.entity[x]", "short": "Contract Valued Item Type", "definition": "Specific type of Contract Valued Item that may be priced.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.identifier", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.identifier", "path": "Contract.valuedItem.identifier", "short": "Contract Valued Item Number", "definition": "Identifies a Contract Valued Item instance.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.effectiveTime", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.effectiveTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.effectiveTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.effectiveTime", "path": "Contract.valuedItem.effectiveTime", "short": "Contract Valued Item Effective Tiem", "definition": "Indicates the time during which this Contract ValuedItem information is effective.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.quantity", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.quantity", "path": "Contract.valuedItem.quantity", "short": "Count of Contract Valued Items", "definition": "Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem unitQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.unitPrice", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.unitPrice", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.unitPrice", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.unitPrice", "path": "Contract.valuedItem.unitPrice", "short": "Contract Valued Item fee, charge, or cost", "definition": "A Contract Valued Item unit valuation measure.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem unitPriceAmt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.factor", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.factor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.factor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.factor", "path": "Contract.valuedItem.factor", "short": "Contract Valued Item Price Scaling Factor", "definition": "A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem factorNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.points", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.points", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.points", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.points", "path": "Contract.valuedItem.points", "short": "Contract Valued Item Difficulty Scaling Factor", "definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem pointNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.valuedItem.net", "resource": { "resourceType": "DataElement", "id": "Contract.valuedItem.net", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.valuedItem.net", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.valuedItem.net", "path": "Contract.valuedItem.net", "short": "Total Contract Valued Item Value", "definition": "Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedItem netAmt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term", "resource": { "resourceType": "DataElement", "id": "Contract.term", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Term" } ], "path": "Contract.term", "short": "Contract Term List", "definition": "One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "RIM mechanism for grouping or nesting rules, which are likely Acts and Observations." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.identifier", "resource": { "resourceType": "DataElement", "id": "Contract.term.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.identifier", "path": "Contract.term.identifier", "short": "Contract Term Number", "definition": "Unique identifier for this particular Contract Provision.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Act or Observation identifier." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.issued", "resource": { "resourceType": "DataElement", "id": "Contract.term.issued", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.issued", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.issued", "path": "Contract.term.issued", "short": "Contract Term Issue Date Time", "definition": "When this Contract Provision was issued.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Act availabilityTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.applies", "resource": { "resourceType": "DataElement", "id": "Contract.term.applies", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.applies", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.applies", "path": "Contract.term.applies", "short": "Contract Term Effective Time", "definition": "Relevant time or time-period when this Contract Provision is applicable.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Act effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.type", "resource": { "resourceType": "DataElement", "id": "Contract.term.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.type", "path": "Contract.term.type", "short": "Contract Term Type or Form", "definition": "Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractTermType" } ], "strength": "example", "description": "Detailed codes for the types of contract provisions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-term-type" } }, "mapping": [ { "identity": "rim", "map": "See Contract.term mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.subType", "resource": { "resourceType": "DataElement", "id": "Contract.term.subType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.subType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.subType", "path": "Contract.term.subType", "short": "Contract Term Type specific classification", "definition": "Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractTermSubType" } ], "strength": "example", "description": "Detailed codes for the subtypes of contract provisions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-term-subtype" } }, "mapping": [ { "identity": "rim", "map": "See Contract.topic mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.topic", "resource": { "resourceType": "DataElement", "id": "Contract.term.topic", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.topic", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.topic", "path": "Contract.term.topic", "short": "Context of the Contract term", "definition": "The matter of concern in the context of this provision of the agrement.", "comment": "The Contract.term.topic, as a Contract Resource subpart, is handled in the same manner as the Contract Resource as discussed above.", "requirements": "A contract term topic is typically about a portion of the contract topic which has additional or specialized rights, privileges, obligations, restrictions, and prohibitions that are binding on any grantor and grantee parties upon the execution of the contract. \rContract.term.topic may be described in more detail in the [0..*] Contract.term.valuedItem @[0..1] Contract.term.valuedItem [x] Definition: Specific type of Contract Provision Valued Item that may be priced. CodeableConcept|Reference(Any) [See Contract.topic Requirements for further elaboration on this requirement.].", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "See Contract.subType mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.action", "resource": { "resourceType": "DataElement", "id": "Contract.term.action", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.action", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.action", "path": "Contract.term.action", "short": "Contract Term Activity", "definition": "Action stipulated by this Contract Provision.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractAction" } ], "strength": "example", "description": "Detailed codes for the contract action.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-action" } }, "mapping": [ { "identity": "rim", "map": "See Contract.action mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.actionReason", "resource": { "resourceType": "DataElement", "id": "Contract.term.actionReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.actionReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.actionReason", "path": "Contract.term.actionReason", "short": "Purpose for the Contract Term Action", "definition": "Reason or purpose for the action stipulated by this Contract Provision.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractActionReason" } ], "strength": "example", "description": "Detailed codes for the contract action reason.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse" } }, "mapping": [ { "identity": "rim", "map": "See Contract.actionReason mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.securityLabel", "resource": { "resourceType": "DataElement", "id": "Contract.term.securityLabel", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.securityLabel", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.securityLabel", "path": "Contract.term.securityLabel", "short": "Security Labels that define affected terms", "definition": "A set of security labels that define which terms are controlled by this condition.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } }, "mapping": [ { "identity": "rim", "map": "See Contract.securityLabel mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.agent", "resource": { "resourceType": "DataElement", "id": "Contract.term.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.agent", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "TermAgent" } ], "path": "Contract.term.agent", "short": "Contract Term Agent List", "definition": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.", "comment": "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.\rFor example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, software, or system process. However, only one user may be the initiator/requestor for the event.", "requirements": "An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "See Contract.agent mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.agent.actor", "resource": { "resourceType": "DataElement", "id": "Contract.term.agent.actor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.agent.actor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.agent.actor", "path": "Contract.term.agent.actor", "short": "Contract Term Agent Subject", "definition": "The agent assigned a role in this Contract Provision.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Contract" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "mapping": [ { "identity": "rim", "map": "See Contract.agent.actor mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.agent.role", "resource": { "resourceType": "DataElement", "id": "Contract.term.agent.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.agent.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.agent.role", "path": "Contract.term.agent.role", "short": "Type of the Contract Term Agent", "definition": "Role played by the agent assigned this role in the execution of this Contract Provision.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContractActorRole" } ], "strength": "example", "description": "Detailed codes for the contract actor role.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contract-actorrole" } }, "mapping": [ { "identity": "rim", "map": "See Contract.agent.role mapping." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.text", "resource": { "resourceType": "DataElement", "id": "Contract.term.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.text", "path": "Contract.term.text", "short": "Human readable Contract term text", "definition": "Human readable form of this Contract Provision.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "TermValuedItem" } ], "path": "Contract.term.valuedItem", "short": "Contract Term Valued Item List", "definition": "Contract Provision Valued Item List.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem classCode INVE" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.entityX", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.entityX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.entityX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.entity[x]", "path": "Contract.term.valuedItem.entity[x]", "short": "Contract Term Valued Item Type", "definition": "Specific type of Contract Provision Valued Item that may be priced.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.identifier", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.identifier", "path": "Contract.term.valuedItem.identifier", "short": "Contract Term Valued Item Number", "definition": "Identifies a Contract Provision Valued Item instance.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.effectiveTime", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.effectiveTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.effectiveTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.effectiveTime", "path": "Contract.term.valuedItem.effectiveTime", "short": "Contract Term Valued Item Effective Tiem", "definition": "Indicates the time during which this Contract Term ValuedItem information is effective.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.quantity", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.quantity", "path": "Contract.term.valuedItem.quantity", "short": "Contract Term Valued Item Count", "definition": "Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem unitQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.unitPrice", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.unitPrice", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.unitPrice", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.unitPrice", "path": "Contract.term.valuedItem.unitPrice", "short": "Contract Term Valued Item fee, charge, or cost", "definition": "A Contract Provision Valued Item unit valuation measure.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem unitPriceAmt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.factor", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.factor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.factor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.factor", "path": "Contract.term.valuedItem.factor", "short": "Contract Term Valued Item Price Scaling Factor", "definition": "A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem factorNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.points", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.points", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.points", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.points", "path": "Contract.term.valuedItem.points", "short": "Contract Term Valued Item Difficulty Scaling Factor", "definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem pointNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.net", "resource": { "resourceType": "DataElement", "id": "Contract.term.valuedItem.net", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.valuedItem.net", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.valuedItem.net", "path": "Contract.term.valuedItem.net", "short": "Total Contract Term Valued Item Value", "definition": "Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "rim", "map": "COCT_RM440000UV09 ValuedUnitItem net" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.term.group", "resource": { "resourceType": "DataElement", "id": "Contract.term.group", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.term.group", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.term.group", "path": "Contract.term.group", "short": "Nested Contract Term Group", "definition": "Nested group of Contract Provisions.", "min": 0, "max": "*", "contentReference": "#Contract.term", "mapping": [ { "identity": "rim", "map": "RIM Grouping or Nesting mechanisms" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.bindingX", "resource": { "resourceType": "DataElement", "id": "Contract.bindingX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.bindingX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.binding[x]", "path": "Contract.binding[x]", "short": "Binding Contract", "definition": "Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the \"source of truth\" and which would be the basis for legal action related to enforcement of this Contract.", "min": 0, "max": "1", "type": [ { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Composition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" } ], "mapping": [ { "identity": "rim", "map": "DocumentCompletion code system AU (authenticated) Description: A completion status in which a document has been signed manually or electronically by one or more individuals who attest to its accuracy. No explicit determination is made that the assigned individual has performed the authentication. While the standard allows multiple instances of authentication, it would be typical to have a single instance of authentication, usually by the assigned individual." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.friendly", "resource": { "resourceType": "DataElement", "id": "Contract.friendly", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.friendly", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.friendly", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "FriendlyLanguage" } ], "path": "Contract.friendly", "short": "Contract Friendly Language", "definition": "The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.friendly.contentX", "resource": { "resourceType": "DataElement", "id": "Contract.friendly.contentX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.friendly.contentX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.friendly.content[x]", "path": "Contract.friendly.content[x]", "short": "Easily comprehended representation of this Contract", "definition": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.", "min": 1, "max": "1", "type": [ { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Composition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" } ], "mapping": [ { "identity": "rim", "map": "Act.text Definition: A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Act." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.legal", "resource": { "resourceType": "DataElement", "id": "Contract.legal", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.legal", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.legal", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "LegalLanguage" } ], "path": "Contract.legal", "short": "Contract Legal Language", "definition": "List of Legal expressions or representations of this Contract.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.legal.contentX", "resource": { "resourceType": "DataElement", "id": "Contract.legal.contentX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.legal.contentX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.legal.content[x]", "path": "Contract.legal.content[x]", "short": "Contract Legal Text", "definition": "Contract legal text in human renderable form.", "min": 1, "max": "1", "type": [ { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Composition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" } ], "mapping": [ { "identity": "rim", "map": "Example: Act.text of an Act coded as with ActPrivacyLaw, ActPolicy code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.rule", "resource": { "resourceType": "DataElement", "id": "Contract.rule", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.rule", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.rule", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ComputableLanguage" } ], "path": "Contract.rule", "short": "Computable Contract Language", "definition": "List of Computable Policy Rule Language Representations of this Contract.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Contract.rule.contentX", "resource": { "resourceType": "DataElement", "id": "Contract.rule.contentX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Contract.rule.contentX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Contract.rule.content[x]", "path": "Contract.rule.content[x]", "short": "Computable Contract Rules", "definition": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).", "min": 1, "max": "1", "type": [ { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference" } ], "mapping": [ { "identity": "rim", "map": "Computable Policy Consent [Observation: templateId 2.16.840.1.113883.3.445.16] This template is used to represent an alternative representation of the Privacy Consent Directive (e.g.,ODRL, XrML, XACML) as a computer-readable set of rules. An implementation may use any appropriate representations of the privacy consent in addition to the \"ConsentDirectiveStructuredDefinition\" which uses the Clinical Template structure to express the elements of a consent directive in an interoperable way.\r1. SHALL contain exactly one [1..1] templateId ( CONF-CD-16 ) such that it\ra. SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.3.445.16\"\r2. SHALL contain exactly one [1..1] @moodCode=\"DEF\" (CodeSystem: 2.16.840.1.113883.5.1001 HL7ActMood) (CONF:14912)\r3. SHALL contain exactly one [1..1] code (CONF:9139)/@code=\"57016-8\" Privacy Policy Acknowledgement Document (CodeSystem: 2.16.840.1.113883.6.1 LOINC) (CONF:9138)\rIt specifies the LOINC code corresponding to \"Privacy Policy Acknowledgement Document\", it is fixed at this value.\r4. SHOULD contain zero or more [0..*] value with @xsi:type=\"ANY\" (CONF:9140) The value contains the computable representation of the policy. This may be a standard-based access control or attribute control based policy (See\r\"References\"). Computable Policy Consent example\r<!-- Sample computable policy language representation -->\r<entryRelationship typeCode=\"COMP\">\r<templateId root=\"2.16.840.1.113883.3.445.16\" />\r<observationMedia classCode=\"OBS\" moodCode=\"EVN\">\r<value mediaType=\"text/xml\" representation=\"TXT\"> ... </value>\r</observationMedia>\r</entryRelationship>" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment", "resource": { "resourceType": "DataElement", "id": "RiskAssessment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment", "path": "RiskAssessment", "short": "Potential outcomes for a subject with likelihood", "definition": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.", "alias": [ "Prognosis" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN, code=\"Risk Assessment\"]" }, { "identity": "openehr", "map": "OpenEHR-EHR-EVALUATION.risk.v1" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.identifier", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.identifier", "path": "RiskAssessment.identifier", "short": "Unique identifier for the assessment", "definition": "Business identifier assigned to the risk assessment.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "openehr", "map": "Workflow Identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.basedOn", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.basedOn", "path": "RiskAssessment.basedOn", "short": "Request fulfilled by this assessment", "definition": "A reference to the request that is fulfilled by this risk assessment.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Event.basedOn" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.parent", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.parent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.parent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.parent", "path": "RiskAssessment.parent", "short": "Part of this occurrence", "definition": "A reference to a resource that this risk assessment is part of, such as a Procedure.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Event.partOf" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.status", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.status", "path": "RiskAssessment.status", "short": "registered | preliminary | final | amended +", "definition": "The status of the RiskAssessment, using the same statuses as an Observation.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RiskAssessmentStatus" } ], "strength": "required", "description": "The status of the risk assessment; e.g. preliminary, final, amended, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.method", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.method", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.method", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.method", "path": "RiskAssessment.method", "short": "Evaluation mechanism", "definition": "The algorithm, process or mechanism used to evaluate the risk.", "requirements": "The method can influence the results of the assessment.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RiskAssessmentMethod" } ], "strength": "example", "description": "The mechanism or algorithm used to make the assessment; e.g. TIMI, PRISM, Cardiff Type 2 diabetes, etc." }, "mapping": [ { "identity": "rim", "map": ".methodCode" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.code", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.code", "path": "RiskAssessment.code", "short": "Type of assessment", "definition": "The type of the risk assessment performed.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.subject", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.subject", "path": "RiskAssessment.subject", "short": "Who/what does assessment apply to?", "definition": "The patient or group the risk assessment applies to.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "openehr", "map": "Subject of Care" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.context", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.context", "path": "RiskAssessment.context", "short": "Where was assessment performed?", "definition": "The encounter where the assessment was performed.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.occurrenceX", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.occurrenceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.occurrenceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.occurrence[x]", "path": "RiskAssessment.occurrence[x]", "short": "When was assessment made?", "definition": "The date (and possibly time) the risk assessment was performed.", "requirements": "The assessment results lose validity the more time elapses from when they are first made.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.condition", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.condition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.condition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.condition", "path": "RiskAssessment.condition", "short": "Condition assessed", "definition": "For assessments or prognosis specific to a particular condition, indicates the condition being assessed.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.performer", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.performer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.performer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.performer", "path": "RiskAssessment.performer", "short": "Who did assessment?", "definition": "The provider or software application that performed the assessment.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "rim", "map": ".participation[typeCode=PFM].role[classCode=ASSIGNED]" }, { "identity": "openehr", "map": "Information Provider" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.reasonX", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.reasonX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.reasonX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.reason[x]", "path": "RiskAssessment.reason[x]", "short": "Why the assessment was necessary?", "definition": "The reason the risk assessment was performed.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Event.reason" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.basis", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.basis", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.basis", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.basis", "path": "RiskAssessment.basis", "short": "Information used in assessment", "definition": "Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DRIV].target" }, { "identity": "openehr", "map": "Risk Factor; Link to Evidence" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.prediction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.prediction", "path": "RiskAssessment.prediction", "short": "Outcome predicted", "definition": "Describes the expected outcome for the subject.", "comment": "Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "ras-2", "severity": "error", "human": "Must be <= 100", "expression": "probability is decimal implies probability.as(decimal) <= 100", "xpath": "not(f:probabilityDecimal) or f:probabilityDecimal/@value <= 100" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=VALUE].target[classCod=OBS, moodCode=RISK]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.outcome", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.prediction.outcome", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.outcome", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.prediction.outcome", "path": "RiskAssessment.prediction.outcome", "short": "Possible outcome for the subject", "definition": "One of the potential outcomes for the patient (e.g. remission, death, a particular condition).", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RiskAssessmentOutcome" } ], "strength": "example", "description": "The condition or other outcome; e.g. death, remission, amputation, infection, etc." }, "mapping": [ { "identity": "rim", "map": ".value" }, { "identity": "openehr", "map": "Risk" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.probabilityX", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.prediction.probabilityX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.probabilityX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.prediction.probability[x]", "path": "RiskAssessment.prediction.probability[x]", "short": "Likelihood of specified outcome", "definition": "How likely is the outcome (in the specified timeframe).", "comment": "If range is used, it represents the lower and upper bounds of certainty; e.g. 40-60% Decimal values are expressed as percentages as well (max = 100).", "min": 0, "max": "1", "type": [ { "code": "decimal" }, { "code": "Range" } ], "constraint": [ { "key": "ras-1", "severity": "error", "human": "low and high must be percentages, if present", "expression": "(low.empty() or ((low.code = '%') and (low.system = %ucum))) and (high.empty() or ((high.code = '%') and (high.system = %ucum)))", "xpath": "(not(f:low) or f:low[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org']) and (not(f:high) or f:high[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org'])" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"probability\"].value" }, { "identity": "openehr", "map": "Category" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.qualitativeRisk", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.prediction.qualitativeRisk", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.qualitativeRisk", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.prediction.qualitativeRisk", "path": "RiskAssessment.prediction.qualitativeRisk", "short": "Likelihood of specified outcome as a qualitative value", "definition": "How likely is the outcome (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, high).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RiskAssessmentProbability" } ], "strength": "example", "description": "The likelihood of the occurrence of a specified outcome", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/risk-probability" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.relativeRisk", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.prediction.relativeRisk", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.relativeRisk", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.prediction.relativeRisk", "path": "RiskAssessment.prediction.relativeRisk", "short": "Relative likelihood", "definition": "Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).", "requirements": "Absolute risk is less meaningful than relative risk.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"relative risk\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.whenX", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.prediction.whenX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.whenX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.prediction.when[x]", "path": "RiskAssessment.prediction.when[x]", "short": "Timeframe or age range", "definition": "Indicates the period of time or age range of the subject to which the specified probability applies.", "comment": "If not specified, the risk applies \"over the subject's lifespan\".", "min": 0, "max": "1", "type": [ { "code": "Period" }, { "code": "Range" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.rationale", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.prediction.rationale", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.prediction.rationale", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.prediction.rationale", "path": "RiskAssessment.prediction.rationale", "short": "Explanation of prediction", "definition": "Additional information explaining the basis for the prediction.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".reasonCode.text" }, { "identity": "openehr", "map": "Rationale" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.mitigation", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.mitigation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.mitigation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.mitigation", "path": "RiskAssessment.mitigation", "short": "How to reduce risk", "definition": "A description of the steps that might be taken to reduce the identified risk(s).", "requirements": "One of the main reasons for assessing risks is to identify whether interventional steps are needed to reduce risk.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=MTGT].target[classCode=ACT, moodCode=EVN].text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RiskAssessment.comment", "resource": { "resourceType": "DataElement", "id": "RiskAssessment.comment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RiskAssessment.comment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RiskAssessment.comment", "path": "RiskAssessment.comment", "short": "Comments on the risk assessment", "definition": "Additional comments about the risk assessment.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "workflow", "map": "Event.note" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group", "resource": { "resourceType": "DataElement", "id": "Group", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group", "status": "draft", "experimental": true, "stringency": "fully-specified", "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.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "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))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]" }, { "identity": "w5", "map": "administrative.group" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.identifier", "resource": { "resourceType": "DataElement", "id": "Group.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.active", "resource": { "resourceType": "DataElement", "id": "Group.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "defaultValueBoolean": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "./statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.type", "resource": { "resourceType": "DataElement", "id": "Group.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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, Medicaiton 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" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/group-type" } }, "mapping": [ { "identity": "rim", "map": "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\"" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.actual", "resource": { "resourceType": "DataElement", "id": "Group.actual", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.actual", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "true: ./determinerCode=\"GRP\" false: ./determinerCode=\"GRP_KIND\"" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.code", "resource": { "resourceType": "DataElement", "id": "Group.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "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": "rim", "map": "./code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.name", "resource": { "resourceType": "DataElement", "id": "Group.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./name[type=\"ST\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.quantity", "resource": { "resourceType": "DataElement", "id": "Group.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.characteristic", "resource": { "resourceType": "DataElement", "id": "Group.characteristic", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.characteristic", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Group.characteristic", "path": "Group.characteristic", "short": "Trait of group members", "definition": "Identifies the traits 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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.characteristic.code", "resource": { "resourceType": "DataElement", "id": "Group.characteristic.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.characteristic.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.characteristic.valueX", "resource": { "resourceType": "DataElement", "id": "Group.characteristic.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.characteristic.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.characteristic.exclude", "resource": { "resourceType": "DataElement", "id": "Group.characteristic.exclude", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.characteristic.exclude", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "./valueNegationInd" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.characteristic.period", "resource": { "resourceType": "DataElement", "id": "Group.characteristic.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.characteristic.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.member", "resource": { "resourceType": "DataElement", "id": "Group.member", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.member", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.member.entity", "resource": { "resourceType": "DataElement", "id": "Group.member.entity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.member.entity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.member.period", "resource": { "resourceType": "DataElement", "id": "Group.member.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.member.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Group.member.inactive", "resource": { "resourceType": "DataElement", "id": "Group.member.inactive", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Group.member.inactive", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "defaultValueBoolean": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice", "resource": { "resourceType": "DataElement", "id": "PaymentNotice", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice", "path": "PaymentNotice", "short": "PaymentNotice request", "definition": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "financial.payment" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.identifier", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.identifier", "path": "PaymentNotice.identifier", "short": "Business Identifier", "definition": "The notice business identifier.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.status", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.status", "path": "PaymentNotice.status", "short": "active | cancelled | draft | entered-in-error", "definition": "The status of the resource instance.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PaymentNoticeStatus" } ], "strength": "required", "description": "A code specifying the state of the resource instance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/fm-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.request", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.request", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.request", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.request", "path": "PaymentNotice.request", "short": "Request reference", "definition": "Reference of resource for which payment is being made.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.response", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.response", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.response", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.response", "path": "PaymentNotice.response", "short": "Response reference", "definition": "Reference of response to resource for which payment is being made.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.statusDate", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.statusDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.statusDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.statusDate", "path": "PaymentNotice.statusDate", "short": "Payment or clearing date", "definition": "The date when the above payment action occurrred.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.created", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.created", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.created", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.created", "path": "PaymentNotice.created", "short": "Creation date", "definition": "The date when this resource was created.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "workflow", "map": "Event.occurrence" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.target", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.target", "path": "PaymentNotice.target", "short": "Insurer or Regulatory body", "definition": "The Insurer who is target of the request.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.provider", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.provider", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.provider", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.provider", "path": "PaymentNotice.provider", "short": "Responsible practitioner", "definition": "The practitioner who is responsible for the services rendered to the patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "cdanetv4", "map": "B01" }, { "identity": "v2", "map": "B01" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.organization", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.organization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.organization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.organization", "path": "PaymentNotice.organization", "short": "Responsible organization", "definition": "The organization which is responsible for the services rendered to the patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "workflow", "map": "Event.performer.onBehalfOf" }, { "identity": "cdanetv4", "map": "B02" }, { "identity": "v2", "map": "B02" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/PaymentNotice.paymentStatus", "resource": { "resourceType": "DataElement", "id": "PaymentNotice.paymentStatus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/PaymentNotice.paymentStatus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "PaymentNotice.paymentStatus", "path": "PaymentNotice.paymentStatus", "short": "Whether payment has been sent or cleared", "definition": "The payment status, typically paid: payment sent, cleared: payment received.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PaymentStatus" } ], "strength": "example", "description": "The payment conveyance status codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/payment-status" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization", "resource": { "resourceType": "DataElement", "id": "Organization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization", "status": "draft", "experimental": true, "stringency": "fully-specified", "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, etc.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "org-1", "severity": "error", "human": "The organization SHALL at least have a name or an id, and possibly more than one", "expression": "(identifier.count() + name.count()) > 0", "xpath": "count(f:identifier | f:name) > 0" } ], "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": "servd", "map": "Organization" }, { "identity": "w5", "map": "administrative.group" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.identifier", "resource": { "resourceType": "DataElement", "id": "Organization.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.10 / XON.3" }, { "identity": "rim", "map": ".scopes[Role](classCode=IDENT)" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.active", "resource": { "resourceType": "DataElement", "id": "Organization.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": "Default is true.\n\nThis active flag is not intended to be used to mark an organizations 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" } ], "defaultValueBoolean": true, "isModifier": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "No equivalent in HL7 v2" }, { "identity": "rim", "map": ".status" }, { "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." }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.type", "resource": { "resourceType": "DataElement", "id": "Organization.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "OrganizationType" } ], "strength": "example", "description": "Used to categorize the organization", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/organization-type" } }, "mapping": [ { "identity": "v2", "map": "No equivalent in v2" }, { "identity": "rim", "map": ".code" }, { "identity": "servd", "map": "n/a" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.name", "resource": { "resourceType": "DataElement", "id": "Organization.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.1" }, { "identity": "rim", "map": ".name" }, { "identity": "servd", "map": ".PreferredName/Name" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.alias", "resource": { "resourceType": "DataElement", "id": "Organization.alias", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.alias", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "rim", "map": ".name" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.telecom", "resource": { "resourceType": "DataElement", "id": "Organization.telecom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.telecom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Organization.telecom", "path": "Organization.telecom", "short": "A contact detail for the organization", "definition": "A contact detail for the organization.", "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.", "requirements": "Human contact for the organization.", "min": 0, "max": "*", "type": [ { "code": "ContactPoint" } ], "condition": [ "org-3" ], "constraint": [ { "key": "org-3", "severity": "error", "human": "The telecom of an organization can never be of use 'home'", "expression": "where(use = 'home').empty()", "xpath": "count(f:use[@value='home']) = 0" } ], "mapping": [ { "identity": "v2", "map": "ORC-22?" }, { "identity": "rim", "map": ".telecom" }, { "identity": "servd", "map": "./ContactPoints" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.address", "resource": { "resourceType": "DataElement", "id": "Organization.address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Organization.address", "path": "Organization.address", "short": "An address for the organization", "definition": "An address for the organization.", "comment": "Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.", "requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.", "min": 0, "max": "*", "type": [ { "code": "Address" } ], "condition": [ "org-2" ], "constraint": [ { "key": "org-2", "severity": "error", "human": "An address of an organization can never be of use 'home'", "expression": "where(use = 'home').empty()", "xpath": "count(f:use[@value='home']) = 0" } ], "mapping": [ { "identity": "v2", "map": "ORC-23?" }, { "identity": "rim", "map": ".address" }, { "identity": "servd", "map": "./PrimaryAddress and ./OtherAddresses" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.partOf", "resource": { "resourceType": "DataElement", "id": "Organization.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "No equivalent in HL7 v2" }, { "identity": "rim", "map": ".playedBy[classCode=Part].scoper" }, { "identity": "servd", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.contact", "resource": { "resourceType": "DataElement", "id": "Organization.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Organization.contact", "path": "Organization.contact", "short": "Contact for the organization for a certain purpose", "definition": "Contact for the organization for a certain purpose.", "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.", "requirements": "Need to keep track of assigned contact points within bigger organization.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".contactParty" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.contact.purpose", "resource": { "resourceType": "DataElement", "id": "Organization.contact.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.contact.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Organization.contact.purpose", "path": "Organization.contact.purpose", "short": "The type of contact", "definition": "Indicates a purpose for which the contact can be reached.", "requirements": "Need to distinguish between multiple contact persons.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPartyType" } ], "strength": "extensible", "description": "The purpose for which you would contact a contact party", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contactentity-type" } }, "mapping": [ { "identity": "rim", "map": "./type" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.contact.name", "resource": { "resourceType": "DataElement", "id": "Organization.contact.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.contact.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Organization.contact.name", "path": "Organization.contact.name", "short": "A name associated with the contact", "definition": "A name associated with the contact.", "requirements": "Need to be able to track the person by name.", "min": 0, "max": "1", "type": [ { "code": "HumanName" } ], "mapping": [ { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "./name" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.contact.telecom", "resource": { "resourceType": "DataElement", "id": "Organization.contact.telecom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.contact.telecom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Organization.contact.telecom", "path": "Organization.contact.telecom", "short": "Contact details (telephone, email, etc.) for a contact", "definition": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "min": 0, "max": "*", "type": [ { "code": "ContactPoint" } ], "mapping": [ { "identity": "v2", "map": "PID-13, PID-14" }, { "identity": "rim", "map": "./telecom" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.contact.address", "resource": { "resourceType": "DataElement", "id": "Organization.contact.address", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.contact.address", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Organization.contact.address", "path": "Organization.contact.address", "short": "Visiting or postal addresses for the contact", "definition": "Visiting or postal addresses for the contact.", "requirements": "May need to keep track of a contact party's address for contacting, billing or reporting requirements.", "min": 0, "max": "1", "type": [ { "code": "Address" } ], "mapping": [ { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "./addr" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Organization.endpoint", "resource": { "resourceType": "DataElement", "id": "Organization.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Organization.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam", "resource": { "resourceType": "DataElement", "id": "CareTeam", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam", "path": "CareTeam", "short": "Planned participants in the coordination and delivery of care for a patient or group", "definition": "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a 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()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "w5", "map": "clinical.careprovision" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.identifier", "resource": { "resourceType": "DataElement", "id": "CareTeam.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.identifier", "path": "CareTeam.identifier", "short": "External Ids for this team", "definition": "This records identifiers associated with this care team 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.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.status", "resource": { "resourceType": "DataElement", "id": "CareTeam.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.status", "path": "CareTeam.status", "short": "proposed | active | suspended | inactive | entered-in-error", "definition": "Indicates the current state of the care team.", "comment": "This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CareTeamStatus" } ], "strength": "required", "description": "Indicates the status of the care team.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-team-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.category", "resource": { "resourceType": "DataElement", "id": "CareTeam.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.category", "path": "CareTeam.category", "short": "Type of team", "definition": "Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.", "comment": "There may be multiple axis of categorization and one team may serve multiple purposes.", "requirements": "Used for filtering what teams(s) are retrieved and displayed to different types of users.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CareTeamCategory" } ], "strength": "example", "description": "Indicates the type of care team.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-team-category" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.name", "resource": { "resourceType": "DataElement", "id": "CareTeam.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.name", "path": "CareTeam.name", "short": "Name of the team, such as crisis assessment team", "definition": "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams.", "comment": "The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. \"Red trauma team\"), but its primary purpose is to distinguish between identical teams in a human-friendly way. (\"Team 18735\" isn't as friendly . ).", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.subject", "resource": { "resourceType": "DataElement", "id": "CareTeam.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.subject", "path": "CareTeam.subject", "short": "Who care team is for", "definition": "Identifies the patient or group whose intended care is handled by the team.", "requirements": "Allows the team to care for a group (e.g. marriage) therapy.", "alias": [ "patient" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.context", "resource": { "resourceType": "DataElement", "id": "CareTeam.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.context", "path": "CareTeam.context", "short": "Encounter or episode associated with CareTeam", "definition": "The encounter or episode of care that establishes the context for this care team.", "alias": [ "encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.period", "resource": { "resourceType": "DataElement", "id": "CareTeam.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.period", "path": "CareTeam.period", "short": "Time period team covers", "definition": "Indicates when the team did (or is intended to) come into effect and end.", "requirements": "Allows tracking what team(s) are in effect at a particular time.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.participant", "resource": { "resourceType": "DataElement", "id": "CareTeam.participant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.participant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.participant", "path": "CareTeam.participant", "short": "Members of the team", "definition": "Identifies all people and organizations who are expected to be involved in the care team.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "ctm-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "ctm-1", "severity": "error", "human": "CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner", "expression": "onBehalfOf.exists() implies (member.resolve() is Practitioner)", "xpath": "contains(f:member/f:reference/@value, '/Practitioner/') or not(exists(f:onBehalfOf))" } ], "mapping": [ { "identity": "v2", "map": "REL (REL.4 is always the Patient) ( or PRT?)" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.participant.role", "resource": { "resourceType": "DataElement", "id": "CareTeam.participant.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.participant.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.participant.role", "path": "CareTeam.participant.role", "short": "Type of involvement", "definition": "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc.", "comment": "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CareTeamParticipantRole" } ], "strength": "example", "description": "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/participant-role" } }, "mapping": [ { "identity": "v2", "map": "REL.2 (or PRT-4?)" }, { "identity": "rim", "map": ".functionCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.participant.member", "resource": { "resourceType": "DataElement", "id": "CareTeam.participant.member", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.participant.member", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.participant.member", "path": "CareTeam.participant.member", "short": "Who is involved", "definition": "The specific person or organization who is participating/expected to participate in the care team.", "comment": "Patient only needs to be listed if they have a role other than \"subject of care\".\n\nMember is optional because some participants may be known only by their role, particularly in draft plans.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "REL.5 (or 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": ".role" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.participant.onBehalfOf", "resource": { "resourceType": "DataElement", "id": "CareTeam.participant.onBehalfOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.participant.onBehalfOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.participant.onBehalfOf", "path": "CareTeam.participant.onBehalfOf", "short": "Organization of the practitioner", "definition": "The organization of the practitioner.", "requirements": "Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.participant.period", "resource": { "resourceType": "DataElement", "id": "CareTeam.participant.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.participant.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.participant.period", "path": "CareTeam.participant.period", "short": "Time period of participant", "definition": "Indicates when the specific member or organization did (or is intended to) come into effect and end.", "min": 0, "max": "1", "type": [ { "code": "Period" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.reasonCode", "resource": { "resourceType": "DataElement", "id": "CareTeam.reasonCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.reasonCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.reasonCode", "path": "CareTeam.reasonCode", "short": "Why the care team exists", "definition": "Describes why the care team exists.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CareTeamReason" } ], "strength": "example", "description": "Indicates the reason for the care team.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } }, "mapping": [ { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.reasonReference", "resource": { "resourceType": "DataElement", "id": "CareTeam.reasonReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.reasonReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.reasonReference", "path": "CareTeam.reasonReference", "short": "Why the care team exists", "definition": "Condition(s) that this care team addresses.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" } ], "mapping": [ { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.managingOrganization", "resource": { "resourceType": "DataElement", "id": "CareTeam.managingOrganization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.managingOrganization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.managingOrganization", "path": "CareTeam.managingOrganization", "short": "Organization responsible for the care team", "definition": "The organization responsible for the care team.", "requirements": "Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CareTeam.note", "resource": { "resourceType": "DataElement", "id": "CareTeam.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CareTeam.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CareTeam.note", "path": "CareTeam.note", "short": "Comments made about the CareTeam", "definition": "Comments made about the CareTeam.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide", "path": "ImplementationGuide", "short": "A set of rules about how FHIR is used", "definition": "A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", "min": 1, "max": "1", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "conformance.misc" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.url", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.url", "path": "ImplementationGuide.url", "short": "Logical URI to reference this implementation guide (globally unique)", "definition": "An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process.", "alias": [ "url", "authoritative-url", "destination", "identity" ], "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.version", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.version", "path": "ImplementationGuide.version", "short": "Business version of the implementation guide", "definition": "The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 implementation guide instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the implementation guide with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.name", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.name", "path": "ImplementationGuide.name", "short": "Name for this implementation guide (computer friendly)", "definition": "A natural language name identifying the implementation guide. 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.status", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.status", "path": "ImplementationGuide.status", "short": "draft | active | retired | unknown", "definition": "The status of this implementation guide. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of implementation guides that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired implementation guide without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.experimental", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.experimental", "path": "ImplementationGuide.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of implementation guide that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental implementation guide in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.date", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.date", "path": "ImplementationGuide.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the implementation guide was published. The date must change if and 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 implementation guide 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 implementation guide. 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" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.publisher", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.publisher", "path": "ImplementationGuide.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the implementation guide.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the implementation guide is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide. 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 implementation guide. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the implementation guide. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.contact", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.contact", "path": "ImplementationGuide.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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.description", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.description", "path": "ImplementationGuide.description", "short": "Natural language description of the implementation guide", "definition": "A free text natural language description of the implementation guide from a consumer's perspective.", "comment": "This description can be used to capture details such as why the implementation guide 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 implementation guide 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.useContext", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.useContext", "path": "ImplementationGuide.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.jurisdiction", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.jurisdiction", "path": "ImplementationGuide.jurisdiction", "short": "Intended jurisdiction for implementation guide (if applicable)", "definition": "A legal or geographic region in which the implementation guide is intended to be used.", "comment": "It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.copyright", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.copyright", "path": "ImplementationGuide.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.fhirVersion", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.fhirVersion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.fhirVersion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.fhirVersion", "path": "ImplementationGuide.fhirVersion", "short": "FHIR Version this Implementation Guide targets", "definition": "The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.", "comment": "An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.dependency", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.dependency", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.dependency", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.dependency", "path": "ImplementationGuide.dependency", "short": "Another Implementation guide this depends on", "definition": "Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.dependency.type", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.dependency.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.dependency.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.dependency.type", "path": "ImplementationGuide.dependency.type", "short": "reference | inclusion", "definition": "How the dependency is represented when the guide is published.", "comment": "For information about processing included guides, see [Including Guides]{implementationguide.html#include}.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GuideDependencyType" } ], "strength": "required", "description": "How a dependency is represented when the guide is published.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/guide-dependency-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.dependency.uri", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.dependency.uri", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.dependency.uri", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.dependency.uri", "path": "ImplementationGuide.dependency.uri", "short": "Where to find dependency", "definition": "Where the dependency is located.", "comment": "When a guide is published, and the type is 'include', this will be a relative reference within the guide.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package", "path": "ImplementationGuide.package", "short": "Group of resources as used in .page.package", "definition": "A logical group of resources. Logical groups can be used when building pages.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.name", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.name", "path": "ImplementationGuide.package.name", "short": "Name used .page.package", "definition": "The name for the group, as used in page.package.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.description", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.description", "path": "ImplementationGuide.package.description", "short": "Human readable text describing the package", "definition": "Human readable text describing the package.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.resource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.resource", "path": "ImplementationGuide.package.resource", "short": "Resource in the implementation guide", "definition": "A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.example", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.resource.example", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.example", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.resource.example", "path": "ImplementationGuide.package.resource.example", "short": "If not an example, has its normal meaning", "definition": "Whether a resource is included in the guide as part of the rules defined by the guide, or just as an example of a resource that conforms to the rules and/or help implementers understand the intent of the guide.", "comment": "Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.", "min": 1, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.name", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.resource.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.resource.name", "path": "ImplementationGuide.package.resource.name", "short": "Human Name for the resource", "definition": "A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.description", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.resource.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.resource.description", "path": "ImplementationGuide.package.resource.description", "short": "Reason why included in guide", "definition": "A description of the reason that a resource has been included in the implementation guide.", "comment": "This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.acronym", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.resource.acronym", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.acronym", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.resource.acronym", "path": "ImplementationGuide.package.resource.acronym", "short": "Short code to identify the resource", "definition": "A short code that may be used to identify the resource throughout the implementation guide.", "comment": "This is used when generating schematrons from profiles, for example, but has other uses. Publishing tooling may autogenerate this value, but a human assigned value is more useful. This value must be unique within an implementation guide (across included guides as well).", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.sourceX", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.resource.sourceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.sourceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.resource.source[x]", "path": "ImplementationGuide.package.resource.source[x]", "short": "Location of the resource", "definition": "Where this resource is found.", "comment": "Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.", "min": 1, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.exampleFor", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.package.resource.exampleFor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.package.resource.exampleFor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.package.resource.exampleFor", "path": "ImplementationGuide.package.resource.exampleFor", "short": "Resource this is an example of (if applicable)", "definition": "Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.", "comment": "Examples:\n* StructureDefinition -> Any\n* ValueSet -> expansion\n* OperationDefinition -> Parameters\n* Questionnaire -> QuestionnaireResponse.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.global", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.global", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.global", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.global", "path": "ImplementationGuide.global", "short": "Profiles that apply globally", "definition": "A set of profiles that all resources covered by this implementation guide must conform to.", "comment": "See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.global.type", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.global.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.global.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.global.type", "path": "ImplementationGuide.global.type", "short": "Type this profiles applies to", "definition": "The type of resource that all instances must conform to.", "comment": "The type must match that of the profile that is referred to, but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.global.profile", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.global.profile", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.global.profile", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.global.profile", "path": "ImplementationGuide.global.profile", "short": "Profile that all resources must conform to", "definition": "A reference to the profile that all instances must conform to.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.binary", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.binary", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.binary", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.binary", "path": "ImplementationGuide.binary", "short": "Image, css, script, etc.", "definition": "A binary file that is included in the implementation guide when it is published.", "comment": "This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide.", "min": 0, "max": "*", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page", "path": "ImplementationGuide.page", "short": "Page/Section in the Guide", "definition": "A page / section in the implementation guide. The root page is the implementation guide home page.", "comment": "Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.source", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page.source", "path": "ImplementationGuide.page.source", "short": "Where to find that page", "definition": "The source address for the page.", "comment": "The publishing tool will autogenerate source for list (source = n/a), and inject included implementations for include (source = uri of guide to include).", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.title", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page.title", "path": "ImplementationGuide.page.title", "short": "Short title shown for navigational assistance", "definition": "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.kind", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page.kind", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.kind", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page.kind", "path": "ImplementationGuide.page.kind", "short": "page | example | list | include | directory | dictionary | toc | resource", "definition": "The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GuidePageKind" } ], "strength": "required", "description": "The kind of an included page.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/guide-page-kind" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.type", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page.type", "path": "ImplementationGuide.page.type", "short": "Kind of resource to include in the list", "definition": "For constructed pages, what kind of resources to include in the list.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.package", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page.package", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.package", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page.package", "path": "ImplementationGuide.page.package", "short": "Name of package to include", "definition": "For constructed pages, a list of packages to include in the page (or else empty for everything).", "min": 0, "max": "*", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.format", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page.format", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.format", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page.format", "path": "ImplementationGuide.page.format", "short": "Format of the page (e.g. html, markdown, etc.)", "definition": "The format of the page.", "comment": "This is primarily for the publishing tool, that will convert all pages to html format. HTML pages are pre-processed, see xxxx.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt" } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.page", "resource": { "resourceType": "DataElement", "id": "ImplementationGuide.page.page", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImplementationGuide.page.page", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImplementationGuide.page.page", "path": "ImplementationGuide.page.page", "short": "Nested Pages / Sections", "definition": "Nested Pages/Sections under this page.", "comment": "The implementation guide breadcrumbs are generated from this structure.", "min": 0, "max": "*", "contentReference": "#ImplementationGuide.page" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy", "resource": { "resourceType": "DataElement", "id": "ImagingStudy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy", "path": "ImagingStudy", "short": "A set of images produced in single study (one or more series of references images)", "definition": "Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[classCode=COMPOSITION, moodCode=EVN]" }, { "identity": "dicom", "map": "Reference IHE radiology TF vol 2 table 4.14-1" }, { "identity": "w5", "map": "clinical.diagnostics" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.uid", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.uid", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.uid", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.uid", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "dicom=" } ], "path": "ImagingStudy.uid", "short": "Formal DICOM identifier for the study", "definition": "Formal identifier for the study.", "alias": [ "StudyInstanceUID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "example": [ { "label": "General", "valueOid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "dicom", "map": "(0020,000D)" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.accession", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.accession", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.accession", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.accession", "path": "ImagingStudy.accession", "short": "Related workflow identifier (\"Accession Number\")", "definition": "Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).", "alias": [ "AccessionNumber" ], "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id" }, { "identity": "dicom", "map": "(0008,0050)" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.identifier", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.identifier", "path": "ImagingStudy.identifier", "short": "Other identifiers for the study", "definition": "Other identifiers for the study.", "alias": [ "StudyID" ], "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id (no means to distinguish from uid)" }, { "identity": "dicom", "map": "(0020,0010)" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.availability", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.availability", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.availability", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.availability", "path": "ImagingStudy.availability", "short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE", "definition": "Availability of study (online, offline, or nearline).", "alias": [ "InstanceAvailability" ], "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "InstanceAvailability" } ], "strength": "required", "description": "Availability of the resource", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/instance-availability" } }, "mapping": [ { "identity": "rim", "map": "Not supported" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.modalityList", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.modalityList", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.modalityList", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.modalityList", "path": "ImagingStudy.modalityList", "short": "All series modality if actual acquisition modalities", "definition": "A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).", "alias": [ "ModalitiesInStudy" ], "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImagingModality" } ], "strength": "extensible", "description": "Type of acquired data in the instance", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/dicom-cid29" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "dicom", "map": "(0008,0061)" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.patient", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.patient", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.2.2.html" } ], "path": "ImagingStudy.patient", "short": "Who the images are of", "definition": "The patient imaged in the study.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "dicom", "map": "(0010/*)" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.context", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.context", "path": "ImagingStudy.context", "short": "Originating context", "definition": "The encounter or episode at which the request is initiated.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.started", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.started", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.started", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.started", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html#sect_C.7.2.1" } ], "path": "ImagingStudy.started", "short": "When the study was started", "definition": "Date and time the study started.", "alias": [ "StudyDate", "StudyTime" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "example": [ { "label": "General", "valueDateTime": "2011-01-01T08:01:20+00:00" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "dicom", "map": "(0008,0020)+(0008,0030)" }, { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.basedOn", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.basedOn", "path": "ImagingStudy.basedOn", "short": "Request fulfilled", "definition": "A list of the diagnostic requests that resulted in this imaging study being performed.", "requirements": "To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]" }, { "identity": "w5", "map": "who.cause" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.referrer", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.referrer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.referrer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.referrer", "path": "ImagingStudy.referrer", "short": "Referring physician", "definition": "The requesting/referring physician.", "alias": [ "ReferringPhysiciansName" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.cause" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.interpreter", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.interpreter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.interpreter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.interpreter", "path": "ImagingStudy.interpreter", "short": "Who interpreted images", "definition": "Who read the study and interpreted the images or other content.", "alias": [ "Name of Physician(s) Reading Study" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PRF].role" }, { "identity": "dicom", "map": "(0008,1060)" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.endpoint", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.endpoint", "path": "ImagingStudy.endpoint", "short": "Study access endpoint", "definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.", "comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.", "requirements": "Access methods for viewing (e.g., IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Not supported" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.numberOfSeries", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.numberOfSeries", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.numberOfSeries", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.numberOfSeries", "path": "ImagingStudy.numberOfSeries", "short": "Number of Study Related Series", "definition": "Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.", "alias": [ "NumberOfStudyRelatedSeries" ], "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber" }, { "identity": "dicom", "map": "(0020,1206)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.numberOfInstances", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.numberOfInstances", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.numberOfInstances", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.numberOfInstances", "path": "ImagingStudy.numberOfInstances", "short": "Number of Study Related Instances", "definition": "Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.", "alias": [ "NumberOfStudyRelatedInstances" ], "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber" }, { "identity": "dicom", "map": "(0020,1208)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.procedureReference", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.procedureReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.procedureReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.procedureReference", "path": "ImagingStudy.procedureReference", "short": "The performed Procedure reference", "definition": "A reference to the performed Procedure.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]" }, { "identity": "dicom", "map": "(0008,1032)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.procedureCode", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.procedureCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.procedureCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.procedureCode", "path": "ImagingStudy.procedureCode", "short": "The performed procedure code", "definition": "The code for the performed procedure type.", "alias": [ "ProcedureCodeSequence" ], "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImagingProcedureCode" } ], "strength": "example", "description": "The performed procedure type", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-code" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.reason", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.reason", "path": "ImagingStudy.reason", "short": "Why the study was requested", "definition": "Description of clinical condition indicating why the ImagingStudy was requested.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImagingReason" } ], "strength": "example", "description": "The reason for the study", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-reason" } }, "mapping": [ { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.description", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.description", "path": "ImagingStudy.description", "short": "Institution-generated description", "definition": "Institution-generated description or classification of the Study performed.", "alias": [ "StudyDescription" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "dicom", "map": "(0008,1030)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series", "path": "ImagingStudy.series", "short": "Each study has one or more series of instances", "definition": "Each study has one or more series of images or other content.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.uid", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.uid", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.uid", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.uid", "path": "ImagingStudy.series.uid", "short": "Formal DICOM identifier for this series", "definition": "Formal identifier for this series.", "alias": [ "SeriesInstanceUID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "example": [ { "label": "General", "valueOid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "dicom", "map": "(0020,000E)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.number", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.number", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.number", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.number", "path": "ImagingStudy.series.number", "short": "Numeric identifier of this series", "definition": "The numeric identifier of this series in the study.", "alias": [ "SeriesNumber" ], "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "example": [ { "label": "General", "valueUnsignedInt": 3 } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber" }, { "identity": "dicom", "map": "(0020,0011)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.modality", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.modality", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.modality", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.modality", "path": "ImagingStudy.series.modality", "short": "The modality of the instances in the series", "definition": "The modality of this series sequence.", "alias": [ "Modality" ], "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImagingModality" } ], "strength": "extensible", "description": "Type of acquired data in the instance", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/dicom-cid29" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "dicom", "map": "(0008,0060)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.description", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.description", "path": "ImagingStudy.series.description", "short": "A short human readable summary of the series", "definition": "A description of the series.", "alias": [ "SeriesDescription" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "CT Surview 180" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "dicom", "map": "(0008,103E)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.numberOfInstances", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.numberOfInstances", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.numberOfInstances", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.numberOfInstances", "path": "ImagingStudy.series.numberOfInstances", "short": "Number of Series Related Instances", "definition": "Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.", "alias": [ "NumberOfSeriesRelatedInstances" ], "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber" }, { "identity": "dicom", "map": "(0020,1209)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.availability", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.availability", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.availability", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.availability", "path": "ImagingStudy.series.availability", "short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE", "definition": "Availability of series (online, offline or nearline).", "alias": [ "InstanceAvailability" ], "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "InstanceAvailability" } ], "strength": "required", "description": "Availability of the resource", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/instance-availability" } }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value" }, { "identity": "dicom", "map": "(0008,0056)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.endpoint", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.endpoint", "path": "ImagingStudy.series.endpoint", "short": "Series access endpoint", "definition": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.", "comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.", "requirements": "Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Not supported" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.bodySite", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.bodySite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.bodySite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.bodySite", "path": "ImagingStudy.series.bodySite", "short": "Body part examined", "definition": "The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.", "alias": [ "BodyPartExamined" ], "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "rim", "map": ".targetSiteCode" }, { "identity": "dicom", "map": "(0018,0015)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.laterality", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.laterality", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.laterality", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.laterality", "path": "ImagingStudy.series.laterality", "short": "Body part laterality", "definition": "The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Laterality" } ], "strength": "example", "description": "Codes describing body site laterality (left, right, etc.).", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/bodysite-laterality" } }, "mapping": [ { "identity": "rim", "map": ".targetSiteCode" }, { "identity": "dicom", "map": "(0020,0060)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.started", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.started", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.started", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.started", "path": "ImagingStudy.series.started", "short": "When the series started", "definition": "The date and time the series was started.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "dicom", "map": "(0008,0021) + (0008,0031)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.performer", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.performer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.performer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.performer", "path": "ImagingStudy.series.performer", "short": "Who performed the series", "definition": "The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.", "alias": [ "PerformingPhysicianName", "OperatorName" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PRF].role" }, { "identity": "dicom", "map": "(0008,1050) | (0008,1072)" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.instance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.instance", "path": "ImagingStudy.series.instance", "short": "A single SOP instance from the series", "definition": "A single SOP instance within the series, e.g. an image, or presentation state.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.uid", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.instance.uid", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.uid", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.instance.uid", "path": "ImagingStudy.series.instance.uid", "short": "Formal DICOM identifier for this instance", "definition": "Formal identifier for this image or other content.", "alias": [ "SOPInstanceUID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "example": [ { "label": "General", "valueOid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903" } ], "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "dicom", "map": "(0008,0018)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.number", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.instance.number", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.number", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.instance.number", "path": "ImagingStudy.series.instance.number", "short": "The number of this instance in the series", "definition": "The number of instance in the series.", "alias": [ "InstanceNumber" ], "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "example": [ { "label": "General", "valueUnsignedInt": 1 } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber" }, { "identity": "dicom", "map": "(0020,0013)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.sopClass", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.instance.sopClass", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.sopClass", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.instance.sopClass", "path": "ImagingStudy.series.instance.sopClass", "short": "DICOM class type", "definition": "DICOM instance type.", "alias": [ "SOPClassUID" ], "min": 1, "max": "1", "type": [ { "code": "oid" } ], "example": [ { "label": "General", "valueOid": "urn:oid:1.2.840.10008.5.1.4.1.1.2" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value" }, { "identity": "dicom", "map": "(0008,0016)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.title", "resource": { "resourceType": "DataElement", "id": "ImagingStudy.series.instance.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImagingStudy.series.instance.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImagingStudy.series.instance.title", "path": "ImagingStudy.series.instance.title", "short": "Description of instance", "definition": "The description of the instance.", "comment": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".title" }, { "identity": "dicom", "map": "(0070,0080) | (0040,A043) > (0008,0104) | (0042,0010) | (0008,0008)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent", "resource": { "resourceType": "DataElement", "id": "DeviceComponent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent", "path": "DeviceComponent", "short": "An instance of a medical-related component of a medical device", "definition": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", "comment": "For the initial scope, this DeviceComponent resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "w5", "map": "administrative.device" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.identifier", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.identifier", "path": "DeviceComponent.identifier", "short": "Instance id assigned by the software stack", "definition": "The locally assigned unique identification by the software. For example: handle ID.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.type", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.type", "path": "DeviceComponent.type", "short": "What kind of component it is", "definition": "The component type as defined in the object-oriented or metric nomenclature partition.", "comment": "DeviceComponent.type can be referred to either GDMN (nomenclature system supported by FDA Global UDI Database) or preferable RTMMS coding system.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ComponentType" } ], "strength": "preferred", "description": "Describes the type of the component.", "valueSetUri": "http://hl7.org/fhir/ValueSet/device-kind" }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.lastSystemChange", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.lastSystemChange", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.lastSystemChange", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.lastSystemChange", "path": "DeviceComponent.lastSystemChange", "short": "Recent system change timestamp", "definition": "The timestamp for the most recent system change which includes device configuration or setting change.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.source", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.source", "path": "DeviceComponent.source", "short": "Top-level device resource link", "definition": "The link to the source Device that contains administrative device information such as manufacture, serial number, etc.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.parent", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.parent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.parent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.parent", "path": "DeviceComponent.parent", "short": "Parent resource link", "definition": "The link to the parent resource. For example: Channel is linked to its VMD parent.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.operationalStatus", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.operationalStatus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.operationalStatus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.operationalStatus", "path": "DeviceComponent.operationalStatus", "short": "Current operational status of the component, for example On, Off or Standby", "definition": "The current operational status of the device. For example: On, Off, Standby, etc.", "comment": "OperationalStatus for the MDS, VMD, or Channel will be bound to a specific ValueSet that is defined in its profile.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceComponentOperationalStatus" } ], "strength": "extensible", "description": "Codes representing the current status of the device - on, off, suspended, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/operational-status" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.parameterGroup", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.parameterGroup", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.parameterGroup", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.parameterGroup", "path": "DeviceComponent.parameterGroup", "short": "Current supported parameter group", "definition": "The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceComponentParameterGroup" } ], "strength": "extensible", "description": "Codes identifying groupings of parameters; e.g. Cardiovascular.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/parameter-group" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.measurementPrinciple", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.measurementPrinciple", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.measurementPrinciple", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.measurementPrinciple", "path": "DeviceComponent.measurementPrinciple", "short": "other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+", "definition": "The physical principle of the measurement. For example: thermal, chemical, acoustical, etc.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasmntPrinciple" } ], "strength": "required", "description": "Different measurement principle supported by the device.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measurement-principle" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.productionSpecification", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.productionSpecification", "path": "DeviceComponent.productionSpecification", "short": "Specification details such as Component Revisions, or Serial Numbers", "definition": "The production specification such as component revision, serial number, etc.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification.specType", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.productionSpecification.specType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification.specType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.productionSpecification.specType", "path": "DeviceComponent.productionSpecification.specType", "short": "Type or kind of production specification, for example serial number or software revision", "definition": "The specification type, such as, serial number, part number, hardware revision, software revision, etc.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceSpecificationSpecType" } ], "strength": "extensible", "description": "Codes for device specification types such as serial number, part number, hardware revision, software revision, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/specification-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification.componentId", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.productionSpecification.componentId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification.componentId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.productionSpecification.componentId", "path": "DeviceComponent.productionSpecification.componentId", "short": "Internal component unique identification", "definition": "The internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacturer can make use of.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification.productionSpec", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.productionSpecification.productionSpec", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.productionSpecification.productionSpec", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.productionSpecification.productionSpec", "path": "DeviceComponent.productionSpecification.productionSpec", "short": "A printable string defining the component", "definition": "The printable string defining the component.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceComponent.languageCode", "resource": { "resourceType": "DataElement", "id": "DeviceComponent.languageCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceComponent.languageCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceComponent.languageCode", "path": "DeviceComponent.languageCode", "short": "Language code for the human-readable text strings produced by the device", "definition": "The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory", "path": "FamilyMemberHistory", "short": "Information about patient's relatives, relevant for patient", "definition": "Significant health events and conditions for a person related to the patient relevant in the context of care for the 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()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "fhs-2", "severity": "error", "human": "Can only have estimatedAge if age[x] is present", "expression": "age.exists() or estimatedAge.empty()", "xpath": "exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))" }, { "key": "fhs-3", "severity": "error", "human": "Not Done Reason can only be specified if NotDone is \"true\"", "expression": "notDone or notDoneReason.exists().not()", "xpath": "f:notDone/@value=true() or not(exists(f:notDoneReason))" }, { "key": "fhs-1", "severity": "error", "human": "Can have age[x] or born[x], but not both", "expression": "age.empty() or born.empty()", "xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "Not in scope for v2" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.identifier", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.identifier", "path": "FamilyMemberHistory.identifier", "short": "External Id(s) for this record", "definition": "This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "requirements": "Need to allow connection to a wider workflow.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.definition", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.definition", "path": "FamilyMemberHistory.definition", "short": "Instantiates protocol or definition", "definition": "A protocol or questionnaire that was adhered to in whole or in part by this event.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.status", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.status", "path": "FamilyMemberHistory.status", "short": "partial | completed | entered-in-error | health-unknown", "definition": "A code specifying the status of the record of the family history of a specific family member.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilyHistoryStatus" } ], "strength": "required", "description": "A code that identifies the status of the family history record.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/history-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.notDone", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.notDone", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.notDone", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.notDone", "path": "FamilyMemberHistory.notDone", "short": "The taking of a family member's history did not occur", "definition": "If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.", "comment": "This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release.", "requirements": "Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".actionNegationInd" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.notDoneReason", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.notDoneReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.notDoneReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.notDoneReason", "path": "FamilyMemberHistory.notDoneReason", "short": "subject-unknown | withheld | unable-to-obtain | deferred", "definition": "Describes why the family member's history is absent.", "comment": "This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason).", "requirements": "This is a separate element to allow it to have a distinct binding from reasonCode.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "fhs-3" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilyHistoryNotDoneReason" } ], "strength": "example", "description": "Codes describing the reason why a family member history was not done.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/history-not-done-reason" } }, "mapping": [ { "identity": "rim", "map": ".reasonCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.patient", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.patient", "path": "FamilyMemberHistory.patient", "short": "Patient history is about", "definition": "The person who this history concerns.", "alias": [ "Proband" ], "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "participation[typeCode=SBJ].role" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.date", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.date", "path": "FamilyMemberHistory.date", "short": "When history was captured/updated", "definition": "The date (and possibly time) when the family member history was taken.", "comment": "This should be captured even if the same as the date on the List aggregating the full family history.", "requirements": "Allows determination of how current the summary is.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.name", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.name", "path": "FamilyMemberHistory.name", "short": "The family member described", "definition": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".", "requirements": "Allows greater ease in ensuring the same person is being talked about.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "name" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.relationship", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.relationship", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.relationship", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.relationship", "path": "FamilyMemberHistory.relationship", "short": "Relationship to the subject", "definition": "The type of relationship this person has to the patient (father, mother, brother etc.).", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilialRelationship" } ], "strength": "example", "description": "The nature of the relationship between the patient and the related person being described in the family member history.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-FamilyMember" } }, "mapping": [ { "identity": "rim", "map": "code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.gender", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.gender", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.gender", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.gender", "path": "FamilyMemberHistory.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.", "requirements": "Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/administrative-gender" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.bornX", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.bornX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.bornX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.born[x]", "path": "FamilyMemberHistory.born[x]", "short": "(approximate) date of birth", "definition": "The actual or approximate date of birth of the relative.", "requirements": "Allows calculation of the relative's age.", "min": 0, "max": "1", "type": [ { "code": "Period" }, { "code": "date" }, { "code": "string" } ], "condition": [ "fhs-1" ], "mapping": [ { "identity": "rim", "map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.ageX", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.ageX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.ageX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.age[x]", "path": "FamilyMemberHistory.age[x]", "short": "(approximate) age", "definition": "The age of the relative at the time the family member history is recorded.", "comment": "use estimatedAge to indicate whether the age is actual or not.", "requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians.", "min": 0, "max": "1", "type": [ { "code": "Age" }, { "code": "Range" }, { "code": "string" } ], "condition": [ "fhs-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.estimatedAge", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.estimatedAge", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.estimatedAge", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.estimatedAge", "path": "FamilyMemberHistory.estimatedAge", "short": "Age is estimated?", "definition": "If true, indicates that the age value specified is an estimated value.", "comment": "This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age.", "requirements": "Clinicians often prefer to specify an estimaged age rather than an age range.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "meaningWhenMissing": "It is unknown whether the age is an estimate or not", "condition": [ "fhs-2" ], "isModifier": true, "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.deceasedX", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.deceasedX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.deceasedX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.deceased[x]", "path": "FamilyMemberHistory.deceased[x]", "short": "Dead? How old/when?", "definition": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", "min": 0, "max": "1", "type": [ { "code": "boolean" }, { "code": "Age" }, { "code": "Range" }, { "code": "date" }, { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.reasonCode", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.reasonCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.reasonCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.reasonCode", "path": "FamilyMemberHistory.reasonCode", "short": "Why was family member history performed?", "definition": "Describes why the family member history occurred in coded or textual form.", "comment": "Textual reasons can be caprued using reasonCode.text.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilyHistoryReason" } ], "strength": "example", "description": "Codes indicating why the family member history was done.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } }, "mapping": [ { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.reasonReference", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.reasonReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.reasonReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.reasonReference", "path": "FamilyMemberHistory.reasonReference", "short": "Why was family member history performed?", "definition": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.note", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.note", "path": "FamilyMemberHistory.note", "short": "General note about related person", "definition": "This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.condition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.condition", "path": "FamilyMemberHistory.condition", "short": "Condition that the related person had", "definition": "The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.", "comment": "If none of the conditions listed have an outcome of \"death\" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.code", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.condition.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.condition.code", "path": "FamilyMemberHistory.condition.code", "short": "Condition suffered by relation", "definition": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionCode" } ], "strength": "example", "description": "Identification of the Condition or diagnosis.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/condition-code" } }, "mapping": [ { "identity": "rim", "map": ".value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.outcome", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.condition.outcome", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.outcome", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.condition.outcome", "path": "FamilyMemberHistory.condition.outcome", "short": "deceased | permanent disability | etc.", "definition": "Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionOutcome" } ], "strength": "example", "description": "The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/condition-outcome" } }, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.onsetX", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.condition.onsetX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.onsetX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.condition.onset[x]", "path": "FamilyMemberHistory.condition.onset[x]", "short": "When condition first manifested", "definition": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", "requirements": "Age of onset of a condition in relatives is predictive of risk for the patient.", "min": 0, "max": "1", "type": [ { "code": "Age" }, { "code": "Range" }, { "code": "Period" }, { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.note", "resource": { "resourceType": "DataElement", "id": "FamilyMemberHistory.condition.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/FamilyMemberHistory.condition.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "FamilyMemberHistory.condition.note", "path": "FamilyMemberHistory.condition.note", "short": "Extra information about condition", "definition": "An area where general notes can be placed about this specific condition.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem", "resource": { "resourceType": "DataElement", "id": "ChargeItem", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem", "path": "ChargeItem", "short": "Item containing charge code(s) associated with the provision of healthcare provider products", "definition": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "FT1" }, { "identity": "rim", "map": "Act[moodCode=EVN]" }, { "identity": "w5", "map": "financial.support" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.identifier", "resource": { "resourceType": "DataElement", "id": "ChargeItem.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.identifier", "path": "ChargeItem.identifier", "short": "Business Identifier for item", "definition": "Identifiers assigned to this event performer or other systems.", "requirements": "Allows identification of the charge Item as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "FT1.2" }, { "identity": "rim", "map": ".identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.definition", "resource": { "resourceType": "DataElement", "id": "ChargeItem.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.definition", "path": "ChargeItem.definition", "short": "Defining information about the code of this charge item", "definition": "References the source of pricing information, rules of application for the code this ChargeItem uses.", "comment": "Target Resource is yet to be defined as a container that holds information about list prices and rules applicable to the charge item code. Once defined, change type back to Reference(Definition Type).", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.status", "resource": { "resourceType": "DataElement", "id": "ChargeItem.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.status", "path": "ChargeItem.status", "short": "planned | billable | not-billable | aborted | billed | entered-in-error | unknown", "definition": "The current state of the ChargeItem.", "comment": "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemStatus" } ], "strength": "required", "description": "Codes identifying the stage lifecycle stage of a ChargeItem", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/chargeitem-status" } }, "mapping": [ { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.partOf", "resource": { "resourceType": "DataElement", "id": "ChargeItem.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.partOf", "path": "ChargeItem.partOf", "short": "Part of referenced ChargeItem", "definition": "ChargeItems can be grouped to larger ChargeItems covering the whole set.", "requirements": "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.", "alias": [ "container" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ChargeItem" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.code", "resource": { "resourceType": "DataElement", "id": "ChargeItem.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.code", "path": "ChargeItem.code", "short": "A code that identifies the charge, like a billing code", "definition": "A code that identifies the charge, like a billing code.", "alias": [ "type" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemCode" } ], "strength": "example", "description": "Example set of codes that can be used for billing purposes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes" } }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "v2", "map": "FT1.7" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.subject", "resource": { "resourceType": "DataElement", "id": "ChargeItem.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.subject", "path": "ChargeItem.subject", "short": "Individual service was done for/to", "definition": "The individual or set of individuals the action is being or was performed on.", "requirements": "Links the event to the Patient context.", "alias": [ "patient" ], "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "v2", "map": "PAT in proximity to FT1 segment" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.context", "resource": { "resourceType": "DataElement", "id": "ChargeItem.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.context", "path": "ChargeItem.context", "short": "Encounter / Episode associated with event", "definition": "The encounter or episode of care that establishes the context for this event.", "requirements": "Links the request to the Encounter context.", "alias": [ "encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "v2", "map": "PV1 in proximity to FT1 segment" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.occurrenceX", "resource": { "resourceType": "DataElement", "id": "ChargeItem.occurrenceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.occurrenceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.occurrence[x]", "path": "ChargeItem.occurrence[x]", "short": "When the charged service was applied", "definition": "Date/time(s) or duration when the charged service was applied.", "comment": "The list of types may be constrained as appropriate for the type of charge item.", "alias": [ "timing" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.participant", "resource": { "resourceType": "DataElement", "id": "ChargeItem.participant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.participant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.participant", "path": "ChargeItem.participant", "short": "Who performed charged service", "definition": "Indicates who or what performed or participated in the charged service.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.participant.role", "resource": { "resourceType": "DataElement", "id": "ChargeItem.participant.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.participant.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.participant.role", "path": "ChargeItem.participant.role", "short": "What type of performance was done", "definition": "Describes the type of performance or participation(e.g. primary surgeon, anaesthesiologiest, etc.).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemPerformerRole" } ], "strength": "example", "description": "Codes describing the types of functional roles performers can take on when performing events", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/performer-role" } }, "mapping": [ { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".participation.functionCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.participant.actor", "resource": { "resourceType": "DataElement", "id": "ChargeItem.participant.actor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.participant.actor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.participant.actor", "path": "ChargeItem.participant.actor", "short": "Individual who was performing", "definition": "The device, practitioner, etc. who performed or participated in the service.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".player" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.performingOrganization", "resource": { "resourceType": "DataElement", "id": "ChargeItem.performingOrganization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.performingOrganization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.performingOrganization", "path": "ChargeItem.performingOrganization", "short": "Organization providing the charged sevice", "definition": "The organization requesting the service.", "comment": "Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.requestingOrganization", "resource": { "resourceType": "DataElement", "id": "ChargeItem.requestingOrganization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.requestingOrganization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.requestingOrganization", "path": "ChargeItem.requestingOrganization", "short": "Organization requesting the charged service", "definition": "The organization performing the service.", "comment": "The rendered Service may not be associated with a Request. It has to be made clear, ob which Organization's Request, the services have been rendered. (In many cases, this may just be the Department associated with the Encounter.location).", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.quantity", "resource": { "resourceType": "DataElement", "id": "ChargeItem.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.quantity", "path": "ChargeItem.quantity", "short": "Quantity of which the charge item has been serviced", "definition": "Quantity of which the charge item has been serviced.", "comment": "In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "FT1.10" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.bodysite", "resource": { "resourceType": "DataElement", "id": "ChargeItem.bodysite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.bodysite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.bodysite", "path": "ChargeItem.bodysite", "short": "Anatomical location, if relevant", "definition": "The anatomical location where the related service has been applied.", "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 [body-site-instance](extension-body-site-instance.html). May be a summary code, or a reference to a very precise definition of the location, or both.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "rim", "map": ".targetBodySiteCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.factorOverride", "resource": { "resourceType": "DataElement", "id": "ChargeItem.factorOverride", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.factorOverride", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.factorOverride", "path": "ChargeItem.factorOverride", "short": "Factor overriding the associated rules", "definition": "Factor overriding the factor determined by the rules associated with the code.", "comment": "There is no reason to carry the factor in the instance of a ChargeItem unless special circumstances require a manual override. The factors are usually defined by a set of rules in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.26" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.priceOverride", "resource": { "resourceType": "DataElement", "id": "ChargeItem.priceOverride", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.priceOverride", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.priceOverride", "path": "ChargeItem.priceOverride", "short": "Price overriding the associated rules", "definition": "Total price of the charge overriding the list price associated with the code.", "comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.22" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.overrideReason", "resource": { "resourceType": "DataElement", "id": "ChargeItem.overrideReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.overrideReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.overrideReason", "path": "ChargeItem.overrideReason", "short": "Reason for overriding the list price/factor", "definition": "If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.", "comment": "Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.enterer", "resource": { "resourceType": "DataElement", "id": "ChargeItem.enterer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.enterer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.enterer", "path": "ChargeItem.enterer", "short": "Individual who was entering", "definition": "The device, practitioner, etc. who entered the charge item.", "comment": "The enterer is also te person considered responsible for factor/priceOverrides if applicable.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".player" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.enteredDate", "resource": { "resourceType": "DataElement", "id": "ChargeItem.enteredDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.enteredDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.enteredDate", "path": "ChargeItem.enteredDate", "short": "Date the charge item was entered", "definition": "Date the charge item was entered.", "comment": "The actual date when the service associated with the charge has been rendered is captured in occurrence[x].", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.reason", "resource": { "resourceType": "DataElement", "id": "ChargeItem.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.reason", "path": "ChargeItem.reason", "short": "Why was the charged service rendered?", "definition": "Describes why the event occurred in coded or textual form.", "comment": "If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemReason" } ], "strength": "example", "description": "Example binding for reason", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/icd-10" } }, "mapping": [ { "identity": "workflow", "map": "Event.reasonCodeableConcept" }, { "identity": "v2", "map": "EVN.4 or by domain" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.service", "resource": { "resourceType": "DataElement", "id": "ChargeItem.service", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.service", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.service", "path": "ChargeItem.service", "short": "Which rendered service is being charged?", "definition": "Indicated the rendered service that caused this charge.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Immunization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationDispense" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/SupplyDelivery" } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "v2", "map": "EVN.4 or by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.account", "resource": { "resourceType": "DataElement", "id": "ChargeItem.account", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.account", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.account", "path": "ChargeItem.account", "short": "Account to place this charge", "definition": "Account into which this ChargeItems belongs.", "comment": "Systems posting the ChargeItems may not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Account" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.note", "resource": { "resourceType": "DataElement", "id": "ChargeItem.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.note", "path": "ChargeItem.note", "short": "Comments made about the ChargeItem", "definition": "Comments made about the event by the performer, subject or other participants.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.note" }, { "identity": "v2", "map": "NTE" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ChargeItem.supportingInformation", "resource": { "resourceType": "DataElement", "id": "ChargeItem.supportingInformation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ChargeItem.supportingInformation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ChargeItem.supportingInformation", "path": "ChargeItem.supportingInformation", "short": "Further information supporting the this charge", "definition": "Further information supporting the this charge.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": false } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter", "resource": { "resourceType": "DataElement", "id": "Encounter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter", "path": "Encounter", "short": "An interaction during which services are provided to the patient", "definition": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", "alias": [ "Visit" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Encounter[@moodCode='EVN']" }, { "identity": "w5", "map": "workflow.encounter" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.identifier", "resource": { "resourceType": "DataElement", "id": "Encounter.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.identifier", "path": "Encounter.identifier", "short": "Identifier(s) by which this encounter is known", "definition": "Identifier(s) by which this encounter is known.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.status", "resource": { "resourceType": "DataElement", "id": "Encounter.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.status", "path": "Encounter.status", "short": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +", "definition": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +.", "comment": "Note that internal business rules will detemine the appropraite transitions that may occur between statuses (and also classes).\n\nThis element is labeled as a modifier because the status contains codes that mark the encounter as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterStatus" } ], "strength": "required", "description": "Current state of the encounter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-status" } }, "mapping": [ { "identity": "v2", "map": "No clear equivalent in HL7 v2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.statusHistory", "resource": { "resourceType": "DataElement", "id": "Encounter.statusHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.statusHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.statusHistory", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StatusHistory" } ], "path": "Encounter.statusHistory", "short": "List of past encounter statuses", "definition": "The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.", "comment": "The current status is always found in the current version of the resource, not the status history.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.statusHistory.status", "resource": { "resourceType": "DataElement", "id": "Encounter.statusHistory.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.statusHistory.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.statusHistory.status", "path": "Encounter.statusHistory.status", "short": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +", "definition": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterStatus" } ], "strength": "required", "description": "Current state of the encounter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-status" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.statusHistory.period", "resource": { "resourceType": "DataElement", "id": "Encounter.statusHistory.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.statusHistory.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.statusHistory.period", "path": "Encounter.statusHistory.period", "short": "The time that the episode was in the specified status", "definition": "The time that the episode was in the specified status.", "min": 1, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.class", "resource": { "resourceType": "DataElement", "id": "Encounter.class", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.class", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.class", "path": "Encounter.class", "short": "inpatient | outpatient | ambulatory | emergency +", "definition": "inpatient | outpatient | ambulatory | emergency +.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterClass" } ], "strength": "extensible", "description": "Classification of the encounter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActEncounterCode" } }, "mapping": [ { "identity": "v2", "map": "PV1-2" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.classHistory", "resource": { "resourceType": "DataElement", "id": "Encounter.classHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.classHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.classHistory", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ClassHistory" } ], "path": "Encounter.classHistory", "short": "List of past encounter classes", "definition": "The class history permits the tracking of the encounters transitions without needing to go through the resource history.\n\nThis would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.classHistory.class", "resource": { "resourceType": "DataElement", "id": "Encounter.classHistory.class", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.classHistory.class", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.classHistory.class", "path": "Encounter.classHistory.class", "short": "inpatient | outpatient | ambulatory | emergency +", "definition": "inpatient | outpatient | ambulatory | emergency +.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterClass" } ], "strength": "extensible", "description": "Classification of the encounter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActEncounterCode" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.classHistory.period", "resource": { "resourceType": "DataElement", "id": "Encounter.classHistory.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.classHistory.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.classHistory.period", "path": "Encounter.classHistory.period", "short": "The time that the episode was in the specified class", "definition": "The time that the episode was in the specified class.", "min": 1, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.type", "resource": { "resourceType": "DataElement", "id": "Encounter.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.type", "path": "Encounter.type", "short": "Specific type of encounter", "definition": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).", "comment": "Since there are many ways to further classify encounters, this element is 0..*.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterType" } ], "strength": "example", "description": "The type of encounter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-type" } }, "mapping": [ { "identity": "v2", "map": "PV1-4 / PV1-18" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.priority", "resource": { "resourceType": "DataElement", "id": "Encounter.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.priority", "path": "Encounter.priority", "short": "Indicates the urgency of the encounter", "definition": "Indicates the urgency of the encounter.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Priority" } ], "strength": "example", "description": "Indicates the urgency of the encounter.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActPriority" } }, "mapping": [ { "identity": "v2", "map": "PV2-25" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.subject", "resource": { "resourceType": "DataElement", "id": "Encounter.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.subject", "path": "Encounter.subject", "short": "The patient ro group present at the encounter", "definition": "The patient ro group present at the encounter.", "comment": "While the encounter is always about the patient, the patient may not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).", "alias": [ "patient" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".participation[typeCode=SBJ]/role[classCode=PAT]" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.episodeOfCare", "resource": { "resourceType": "DataElement", "id": "Encounter.episodeOfCare", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.episodeOfCare", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.episodeOfCare", "path": "Encounter.episodeOfCare", "short": "Episode(s) of care that this encounter should be recorded against", "definition": "Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PV1-54, PV1-53" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.incomingReferral", "resource": { "resourceType": "DataElement", "id": "Encounter.incomingReferral", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.incomingReferral", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.incomingReferral", "path": "Encounter.incomingReferral", "short": "The ReferralRequest that initiated this encounter", "definition": "The referral request this encounter satisfies (incoming referral).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" } ], "mapping": [ { "identity": "rim", "map": ".reason.ClinicalDocument" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.participant", "resource": { "resourceType": "DataElement", "id": "Encounter.participant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.participant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.participant", "path": "Encounter.participant", "short": "List of participants involved in the encounter", "definition": "The list of people responsible for providing the service.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ROL" }, { "identity": "rim", "map": ".participation[typeCode=PFM]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.participant.type", "resource": { "resourceType": "DataElement", "id": "Encounter.participant.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.participant.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.participant.type", "path": "Encounter.participant.type", "short": "Role of participant in encounter", "definition": "Role of participant in encounter.", "comment": "The participant type indicates how an individual partitipates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipantType" } ], "strength": "extensible", "description": "Role of participant in encounter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-participant-type" } }, "mapping": [ { "identity": "v2", "map": "ROL-3 (or maybe PRT-4)" }, { "identity": "rim", "map": ".functionCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.participant.period", "resource": { "resourceType": "DataElement", "id": "Encounter.participant.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.participant.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.participant.period", "path": "Encounter.participant.period", "short": "Period of time during the encounter that the participant participated", "definition": "The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "v2", "map": "ROL-5, ROL-6 (or maybe PRT-5)" }, { "identity": "rim", "map": ".time" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.participant.individual", "resource": { "resourceType": "DataElement", "id": "Encounter.participant.individual", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.participant.individual", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.participant.individual", "path": "Encounter.participant.individual", "short": "Persons involved in the encounter other than the patient", "definition": "Persons involved in the encounter other than the patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ROL-4" }, { "identity": "rim", "map": ".role" }, { "identity": "w5", "map": "who" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.appointment", "resource": { "resourceType": "DataElement", "id": "Encounter.appointment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.appointment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.appointment", "path": "Encounter.appointment", "short": "The appointment that scheduled this encounter", "definition": "The appointment that scheduled this encounter.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Appointment" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SCH-1 / SCH-2" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.period", "resource": { "resourceType": "DataElement", "id": "Encounter.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.period", "path": "Encounter.period", "short": "The start and end time of the encounter", "definition": "The start and end time of the encounter.", "comment": "If not (yet) known, the end of the Period may be omitted.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "v2", "map": "PV1-44, PV1-45" }, { "identity": "rim", "map": ".effectiveTime (low & high)" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.length", "resource": { "resourceType": "DataElement", "id": "Encounter.length", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.length", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.length", "path": "Encounter.length", "short": "Quantity of time the encounter lasted (less time absent)", "definition": "Quantity of time the encounter lasted. This excludes the time during leaves of absence.", "comment": "May differ from the time the Encounter.period lasted because of leave of absence.", "min": 0, "max": "1", "type": [ { "code": "Duration" } ], "mapping": [ { "identity": "v2", "map": "(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes" }, { "identity": "rim", "map": ".lengthOfStayQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.reason", "resource": { "resourceType": "DataElement", "id": "Encounter.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.reason", "path": "Encounter.reason", "short": "Reason the encounter takes place (code)", "definition": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.", "comment": "For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).", "alias": [ "Indication", "Admission diagnosis" ], "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterReason" } ], "strength": "preferred", "description": "Reason why the encounter takes place.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-reason" } }, "mapping": [ { "identity": "v2", "map": "EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.diagnosis", "resource": { "resourceType": "DataElement", "id": "Encounter.diagnosis", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.diagnosis", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.diagnosis", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Diagnosis" } ], "path": "Encounter.diagnosis", "short": "The list of diagnosis relevant to this encounter", "definition": "The list of diagnosis relevant to this encounter.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.diagnosis.condition", "resource": { "resourceType": "DataElement", "id": "Encounter.diagnosis.condition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.diagnosis.condition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.diagnosis.condition", "path": "Encounter.diagnosis.condition", "short": "Reason the encounter takes place (resource)", "definition": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.", "comment": "For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).", "alias": [ "Admission diagnosis", "discharge diagnosis", "indication" ], "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" } ], "mapping": [ { "identity": "v2", "map": "Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively." }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.diagnosis.role", "resource": { "resourceType": "DataElement", "id": "Encounter.diagnosis.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.diagnosis.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.diagnosis.role", "path": "Encounter.diagnosis.role", "short": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)", "definition": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosisRole" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "The type of diagnosis this condition represents", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/diagnosis-role" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.diagnosis.rank", "resource": { "resourceType": "DataElement", "id": "Encounter.diagnosis.rank", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.diagnosis.rank", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.diagnosis.rank", "path": "Encounter.diagnosis.rank", "short": "Ranking of the diagnosis (for each role type)", "definition": "Ranking of the diagnosis (for each role type).", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].priority" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.account", "resource": { "resourceType": "DataElement", "id": "Encounter.account", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.account", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.account", "path": "Encounter.account", "short": "The set of accounts that may be used for billing for this Encounter", "definition": "The set of accounts that may be used for billing for this Encounter.", "comment": "The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Account" } ], "mapping": [ { "identity": "rim", "map": ".pertains.A_Account" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization", "path": "Encounter.hospitalization", "short": "Details about the admission to a healthcare service", "definition": "Details about the admission to a healthcare service.", "comment": "An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.\r\rThe duration recorded in the period of this encounter covers the entire scope of this hospitalization record.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.preAdmissionIdentifier", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.preAdmissionIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.preAdmissionIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.preAdmissionIdentifier", "path": "Encounter.hospitalization.preAdmissionIdentifier", "short": "Pre-admission identifier", "definition": "Pre-admission identifier.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "v2", "map": "PV1-5" }, { "identity": "rim", "map": ".id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.origin", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.origin", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.origin", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.origin", "path": "Encounter.hospitalization.origin", "short": "The location from which the patient came before admission", "definition": "The location from which the patient came before admission.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=ORG].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.admitSource", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.admitSource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.admitSource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.admitSource", "path": "Encounter.hospitalization.admitSource", "short": "From where patient was admitted (physician referral, transfer)", "definition": "From where patient was admitted (physician referral, transfer).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdmitSource" } ], "strength": "preferred", "description": "From where the patient was admitted.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-admit-source" } }, "mapping": [ { "identity": "v2", "map": "PV1-14" }, { "identity": "rim", "map": ".admissionReferralSourceCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.reAdmission", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.reAdmission", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.reAdmission", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.reAdmission", "path": "Encounter.hospitalization.reAdmission", "short": "The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission", "definition": "Whether this hospitalization is a readmission and why if known.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReAdmissionType" } ], "strength": "example", "description": "The reason for re-admission of this hospitalization encounter.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0092" } }, "mapping": [ { "identity": "v2", "map": "PV1-13" }, { "identity": "rim", "map": "n/a" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.dietPreference", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.dietPreference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.dietPreference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.dietPreference", "path": "Encounter.hospitalization.dietPreference", "short": "Diet preferences reported by the patient", "definition": "Diet preferences reported by the patient.", "comment": "For example a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).", "requirements": "Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PatientDiet" } ], "strength": "example", "description": "Medical, cultural or ethical food preferences to help with catering requirements.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-diet" } }, "mapping": [ { "identity": "v2", "map": "PV1-38" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code=\"diet\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.specialCourtesy", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.specialCourtesy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.specialCourtesy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.specialCourtesy", "path": "Encounter.hospitalization.specialCourtesy", "short": "Special courtesies (VIP, board member)", "definition": "Special courtesies (VIP, board member).", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Courtesies" } ], "strength": "preferred", "description": "Special courtesies", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-special-courtesy" } }, "mapping": [ { "identity": "v2", "map": "PV1-16" }, { "identity": "rim", "map": ".specialCourtesiesCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.specialArrangement", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.specialArrangement", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.specialArrangement", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.specialArrangement", "path": "Encounter.hospitalization.specialArrangement", "short": "Wheelchair, translator, stretcher, etc.", "definition": "Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Arrangements" } ], "strength": "preferred", "description": "Special arrangements", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-special-arrangements" } }, "mapping": [ { "identity": "v2", "map": "PV1-15 / OBR-30 / OBR-43" }, { "identity": "rim", "map": ".specialArrangementCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.destination", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.destination", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.destination", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.destination", "path": "Encounter.hospitalization.destination", "short": "Location to which the patient is discharged", "definition": "Location to which the patient is discharged.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "v2", "map": "PV1-37" }, { "identity": "rim", "map": ".participation[typeCode=DST]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.dischargeDisposition", "resource": { "resourceType": "DataElement", "id": "Encounter.hospitalization.dischargeDisposition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.hospitalization.dischargeDisposition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.hospitalization.dischargeDisposition", "path": "Encounter.hospitalization.dischargeDisposition", "short": "Category or kind of location after discharge", "definition": "Category or kind of location after discharge.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DischargeDisp" } ], "strength": "example", "description": "Discharge Disposition", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-discharge-disposition" } }, "mapping": [ { "identity": "v2", "map": "PV1-36" }, { "identity": "rim", "map": ".dischargeDispositionCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.location", "resource": { "resourceType": "DataElement", "id": "Encounter.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.location", "path": "Encounter.location", "short": "List of locations where the patient has been", "definition": "List of locations where the patient has been during this encounter.", "comment": "Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type \"kind\" such as \"client's home\" and an encounter.class = \"virtual\".", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=LOC]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.location.location", "resource": { "resourceType": "DataElement", "id": "Encounter.location.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.location.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.location.location", "path": "Encounter.location.location", "short": "Location the encounter takes place", "definition": "The location where the encounter takes place.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "v2", "map": "PV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43" }, { "identity": "rim", "map": ".role" }, { "identity": "w5", "map": "where" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.location.status", "resource": { "resourceType": "DataElement", "id": "Encounter.location.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.location.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.location.status", "path": "Encounter.location.status", "short": "planned | active | reserved | completed", "definition": "The status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.", "comment": "When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterLocationStatus" } ], "strength": "required", "description": "The status of the location.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/encounter-location-status" } }, "mapping": [ { "identity": "rim", "map": ".role.statusCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.location.period", "resource": { "resourceType": "DataElement", "id": "Encounter.location.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.location.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.location.period", "path": "Encounter.location.period", "short": "Time period during which the patient was present at the location", "definition": "Time period during which the patient was present at the location.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".time" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.serviceProvider", "resource": { "resourceType": "DataElement", "id": "Encounter.serviceProvider", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.serviceProvider", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.serviceProvider", "path": "Encounter.serviceProvider", "short": "The custodian organization of this Encounter record", "definition": "An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "v2", "map": "PV1-10 / PL.6 & PL.1 (note: HL7 v2 definition is \"the treatment or type of surgery that the patient is scheduled to receive\"; seems slightly out of alignment with the concept name 'hospital service'. Would not trust that implementations apply this semantic by default)" }, { "identity": "rim", "map": ".particiaption[typeCode=PFM].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Encounter.partOf", "resource": { "resourceType": "DataElement", "id": "Encounter.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Encounter.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Encounter.partOf", "path": "Encounter.partOf", "short": "Another Encounter this encounter is part of", "definition": "Another Encounter of which this encounter is a part of (administratively or in time).", "comment": "This is also used for associating a child's encounter back to the mother's encounter.\r\rRefer to the Notes section in the Patient resource for further details.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance", "resource": { "resourceType": "DataElement", "id": "Substance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance", "path": "Substance", "short": "A homogeneous material with a definite composition", "definition": "A homogeneous material with a definite composition.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Material" }, { "identity": "orim", "map": "fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\\#MAT ]." }, { "identity": "w5", "map": "administrative.entity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.identifier", "resource": { "resourceType": "DataElement", "id": "Substance.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.identifier", "path": "Substance.identifier", "short": "Unique identifier", "definition": "Unique identifier for the substance.", "comment": "This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.status", "resource": { "resourceType": "DataElement", "id": "Substance.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.status", "path": "Substance.status", "short": "active | inactive | entered-in-error", "definition": "A code to indicate if the substance is actively used.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRSubstanceStatus" } ], "strength": "required", "description": "A code to indicate if the substance is actively used", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/substance-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.category", "resource": { "resourceType": "DataElement", "id": "Substance.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.category", "path": "Substance.category", "short": "What class/type of substance this is", "definition": "A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", "comment": "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubstanceCategory" } ], "strength": "extensible", "description": "Category or classification of substance", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/substance-category" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.code", "resource": { "resourceType": "DataElement", "id": "Substance.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.code", "path": "Substance.code", "short": "What substance this is", "definition": "A code (or set of codes) that identify this substance.", "comment": "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubstanceCode" } ], "strength": "example", "description": "Substance codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/substance-code" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "orim", "map": "fhir:Substance.code rdfs:subPropertyOf rim:Entity.code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.description", "resource": { "resourceType": "DataElement", "id": "Substance.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.description", "path": "Substance.description", "short": "Textual description of the substance, comments", "definition": "A description of the substance - its appearance, handling requirements, and other usage notes.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".player.desc" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.instance", "resource": { "resourceType": "DataElement", "id": "Substance.instance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.instance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.instance", "path": "Substance.instance", "short": "If this describes a specific package/container of the substance", "definition": "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "meaningWhenMissing": "If this element is not present, then the substance resource describes a kind of substance", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".player.determinerCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.instance.identifier", "resource": { "resourceType": "DataElement", "id": "Substance.instance.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.instance.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.instance.identifier", "path": "Substance.instance.identifier", "short": "Identifier of the package/container", "definition": "Identifier associated with the package/container (usually a label affixed directly).", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.instance.expiry", "resource": { "resourceType": "DataElement", "id": "Substance.instance.expiry", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.instance.expiry", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.instance.expiry", "path": "Substance.instance.expiry", "short": "When no longer valid to use", "definition": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".expiryTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.instance.quantity", "resource": { "resourceType": "DataElement", "id": "Substance.instance.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.instance.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.instance.quantity", "path": "Substance.instance.quantity", "short": "Amount of substance in the package", "definition": "The amount of the substance.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".player.quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.ingredient", "resource": { "resourceType": "DataElement", "id": "Substance.ingredient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.ingredient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.ingredient", "path": "Substance.ingredient", "short": "Composition information about the substance", "definition": "A substance can be composed of other substances.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".player.scopesRole[classCode=INGR]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.ingredient.quantity", "resource": { "resourceType": "DataElement", "id": "Substance.ingredient.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.ingredient.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.ingredient.quantity", "path": "Substance.ingredient.quantity", "short": "Optional amount (concentration)", "definition": "The amount of the ingredient in the substance - a concentration ratio.", "min": 0, "max": "1", "type": [ { "code": "Ratio" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Substance.ingredient.substanceX", "resource": { "resourceType": "DataElement", "id": "Substance.ingredient.substanceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Substance.ingredient.substanceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Substance.ingredient.substance[x]", "path": "Substance.ingredient.substance[x]", "short": "A component of the substance", "definition": "Another substance that is a component of this substance.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubstanceIngredient" } ], "strength": "example", "description": "Substance Ingredient codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/substance-code" } }, "mapping": [ { "identity": "rim", "map": ".player" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter", "resource": { "resourceType": "DataElement", "id": "SearchParameter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter", "path": "SearchParameter", "short": "Search Parameter for a resource", "definition": "A search parameter that defines a named search item that can be used to search/filter on a resource.", "comment": "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.", "min": 1, "max": "1", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "spd-1", "severity": "error", "human": "If an xpath is present, there SHALL be an xpathUsage", "expression": "xpath.empty() or xpathUsage.exists()", "xpath": "not(exists(f:xpath)) or exists(f:xpathUsage)" }, { "key": "spd-2", "severity": "error", "human": "Search parameters can only have chain names when the search parameter type is 'reference'", "expression": "chain.empty() or type = 'reference'", "xpath": "not(exists(f:chain)) or (f:type/@value = 'reference')" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "conformance.behavior" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.url", "resource": { "resourceType": "DataElement", "id": "SearchParameter.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.url", "path": "SearchParameter.url", "short": "Logical URI to reference this search parameter (globally unique)", "definition": "An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.version", "resource": { "resourceType": "DataElement", "id": "SearchParameter.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.version", "path": "SearchParameter.version", "short": "Business version of the search parameter", "definition": "The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter 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 search parameter instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the search parameter with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.name", "resource": { "resourceType": "DataElement", "id": "SearchParameter.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.name", "path": "SearchParameter.name", "short": "Name for this search parameter (computer friendly)", "definition": "A natural language name identifying the search parameter. 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.status", "resource": { "resourceType": "DataElement", "id": "SearchParameter.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.status", "path": "SearchParameter.status", "short": "draft | active | retired | unknown", "definition": "The status of this search parameter. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of search parameters that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired search parameter without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.experimental", "resource": { "resourceType": "DataElement", "id": "SearchParameter.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.experimental", "path": "SearchParameter.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of search parameter that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental search parameter in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.date", "resource": { "resourceType": "DataElement", "id": "SearchParameter.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.date", "path": "SearchParameter.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the search parameter was published. The date must change if and 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 search parameter 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 search parameter. 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" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.publisher", "resource": { "resourceType": "DataElement", "id": "SearchParameter.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.publisher", "path": "SearchParameter.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the search parameter.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. 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 search parameter. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the search parameter. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.contact", "resource": { "resourceType": "DataElement", "id": "SearchParameter.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.contact", "path": "SearchParameter.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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.useContext", "resource": { "resourceType": "DataElement", "id": "SearchParameter.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.useContext", "path": "SearchParameter.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.jurisdiction", "resource": { "resourceType": "DataElement", "id": "SearchParameter.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.jurisdiction", "path": "SearchParameter.jurisdiction", "short": "Intended jurisdiction for search parameter (if applicable)", "definition": "A legal or geographic region in which the search parameter is intended to be used.", "comment": "It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.purpose", "resource": { "resourceType": "DataElement", "id": "SearchParameter.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.purpose", "path": "SearchParameter.purpose", "short": "Why this search parameter is defined", "definition": "Explaination of why this search parameter is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the search parameter 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 search parameter.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.code", "resource": { "resourceType": "DataElement", "id": "SearchParameter.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.code", "path": "SearchParameter.code", "short": "Code used in URL", "definition": "The code used in the URL or the parameter name in a parameters resource for this search parameter.", "comment": "For maximum compatibility, use only lowercase ASCII characters.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.base", "resource": { "resourceType": "DataElement", "id": "SearchParameter.base", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.base", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.base", "path": "SearchParameter.base", "short": "The resource type(s) this search parameter applies to", "definition": "The base resource type(s) that this search parameter can be used against.", "comment": "A search parameter must always have at least one type. When search parameters have more than one resource, they can be used against any of the listed resource types, or in a cross-type search (see [Cross Resource Search](http.html#xres-search)).", "min": 1, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.type", "resource": { "resourceType": "DataElement", "id": "SearchParameter.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.type", "path": "SearchParameter.type", "short": "number | date | string | token | reference | composite | quantity | uri", "definition": "The type of value a search parameter refers to, and how the content is interpreted.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchParamType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "Data types allowed to be used for search parameters.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/search-param-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.derivedFrom", "resource": { "resourceType": "DataElement", "id": "SearchParameter.derivedFrom", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.derivedFrom", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.derivedFrom", "path": "SearchParameter.derivedFrom", "short": "Original Definition for the search parameter", "definition": "Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.", "comment": "The intent of this is that a server can designate that it provides support for a search parameter defined in the specification itself (e.g. [`value-quantity`](http://hl7.org/fhir/SearchParameter/Observation-value-quantity), but detail how it is supported by the server.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.description", "resource": { "resourceType": "DataElement", "id": "SearchParameter.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.description", "path": "SearchParameter.description", "short": "Natural language description of the search parameter", "definition": "A free text natural language description of the search parameter from a consumer's perspective. and how it used.", "comment": "This description can be used to capture details such as why the search parameter 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 search parameter 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 1, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.expression", "resource": { "resourceType": "DataElement", "id": "SearchParameter.expression", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.expression", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.expression", "path": "SearchParameter.expression", "short": "FHIRPath expression that extracts the values", "definition": "A FHIRPath expression that returns a set of elements for the search parameter.", "comment": "Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "spd-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.xpath", "resource": { "resourceType": "DataElement", "id": "SearchParameter.xpath", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.xpath", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.xpath", "path": "SearchParameter.xpath", "short": "XPath that extracts the values", "definition": "An XPath expression that returns a set of elements for the search parameter.", "comment": "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "spd-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.xpathUsage", "resource": { "resourceType": "DataElement", "id": "SearchParameter.xpathUsage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.xpathUsage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.xpathUsage", "path": "SearchParameter.xpathUsage", "short": "normal | phonetic | nearby | distance | other", "definition": "How the search parameter relates to the set of elements returned by evaluating the xpath query.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "condition": [ "spd-1" ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "XPathUsageType" } ], "strength": "required", "description": "How a search parameter relates to the set of elements returned by evaluating its xpath query.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/search-xpath-usage" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.target", "resource": { "resourceType": "DataElement", "id": "SearchParameter.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.target", "path": "SearchParameter.target", "short": "Types of resource (if a resource reference)", "definition": "Types of resource (if a resource is referenced).", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.comparator", "resource": { "resourceType": "DataElement", "id": "SearchParameter.comparator", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.comparator", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.comparator", "path": "SearchParameter.comparator", "short": "eq | ne | gt | lt | ge | le | sa | eb | ap", "definition": "Comparators supported for the search parameter.", "comment": "If no comparators are listed, clients should not expect servers to support any comparators.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchComparator" } ], "strength": "required", "description": "What Search Comparator Codes are supported in search", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/search-comparator" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.modifier", "resource": { "resourceType": "DataElement", "id": "SearchParameter.modifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.modifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.modifier", "path": "SearchParameter.modifier", "short": "missing | exact | contains | not | text | in | not-in | below | above | type", "definition": "A modifier supported for the search parameter.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchModifierCode" } ], "strength": "required", "description": "A supported modifier for a search parameter.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/search-modifier-code" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.chain", "resource": { "resourceType": "DataElement", "id": "SearchParameter.chain", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.chain", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.chain", "path": "SearchParameter.chain", "short": "Chained names supported", "definition": "Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.", "comment": "Systems are not required to list all the chain names they support, but if they don't list them, clients may not know to use them.", "min": 0, "max": "*", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.component", "resource": { "resourceType": "DataElement", "id": "SearchParameter.component", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.component", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.component", "path": "SearchParameter.component", "short": "For Composite resources to define the parts", "definition": "Used to define the parts of a composite search parameter.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.component.definition", "resource": { "resourceType": "DataElement", "id": "SearchParameter.component.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.component.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.component.definition", "path": "SearchParameter.component.definition", "short": "Defines how the part works", "definition": "The definition of the search parameter that describes this part.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/SearchParameter" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/SearchParameter.component.expression", "resource": { "resourceType": "DataElement", "id": "SearchParameter.component.expression", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/SearchParameter.component.expression", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "SearchParameter.component.expression", "path": "SearchParameter.component.expression", "short": "Subexpression relative to main expression", "definition": "A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.", "comment": "This expression overrides the expression in the definition, and extracts the index values from the outcome of the composite expression.", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition", "path": "ServiceDefinition", "short": "A description of decision support service functionality", "definition": "The ServiceDefinition describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Definition" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.url", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.url", "path": "ServiceDefinition.url", "short": "Logical URI to reference this service definition (globally unique)", "definition": "An absolute URI that is used to identify this service definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the service definition to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.identifier", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.identifier", "path": "ServiceDefinition.identifier", "short": "Additional identifier for the service definition", "definition": "A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.", "comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this service 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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.identifier" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.version", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.version", "path": "ServiceDefinition.version", "short": "Business version of the service definition", "definition": "The identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service 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 service definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the service definition with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.name", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.name", "path": "ServiceDefinition.name", "short": "Name for this service definition (computer friendly)", "definition": "A natural language name identifying the service 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.title", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.title", "path": "ServiceDefinition.title", "short": "Name for this service definition (human friendly)", "definition": "A short, descriptive, user-friendly title for the service definition.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.status", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.status", "path": "ServiceDefinition.status", "short": "draft | active | retired | unknown", "definition": "The status of this service definition. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of service definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired service definition without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "workflow", "map": "Definition.status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.experimental", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.experimental", "path": "ServiceDefinition.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this service definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of service definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental service definition in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level service definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.date", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.date", "path": "ServiceDefinition.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the service definition was published. The date must change if and 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 service 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 service 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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.publisher", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.publisher", "path": "ServiceDefinition.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the service definition.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the service definition is the organization or individual primarily responsible for the maintenance and upkeep of the service 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 service definition. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the service definition. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.description", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.description", "path": "ServiceDefinition.description", "short": "Natural language description of the service definition", "definition": "A free text natural language description of the service definition from a consumer's perspective.", "comment": "This description can be used to capture details such as why the service 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 service 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.description" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.purpose", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.purpose", "path": "ServiceDefinition.purpose", "short": "Why this service definition is defined", "definition": "Explaination of why this service definition is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the service 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 service definition.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.usage", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.usage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.usage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.usage", "path": "ServiceDefinition.usage", "short": "Describes the clinical usage of the module", "definition": "A detailed description of how the module is used from a clinical perspective.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.approvalDate", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.approvalDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.approvalDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.approvalDate", "path": "ServiceDefinition.approvalDate", "short": "When the service definition was approved by publisher", "definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "workflow", "map": "Definition.approvalDate" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.lastReviewDate", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.lastReviewDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.lastReviewDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.lastReviewDate", "path": "ServiceDefinition.lastReviewDate", "short": "When the service definition was last reviewed", "definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.", "comment": "If specified, this is usually after the approval date.", "requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "workflow", "map": "Definition.lastReviewDate" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.effectivePeriod", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.effectivePeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.effectivePeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.effectivePeriod", "path": "ServiceDefinition.effectivePeriod", "short": "When the service definition is expected to be used", "definition": "The period during which the service definition content was or is planned to be in active use.", "comment": "The effective period for a service definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.", "requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the service definition are or are expected to be used instead.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.effectivePeriod" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.useContext", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.useContext", "path": "ServiceDefinition.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate service definition instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.jurisdiction", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.jurisdiction", "path": "ServiceDefinition.jurisdiction", "short": "Intended jurisdiction for service definition (if applicable)", "definition": "A legal or geographic region in which the service definition is intended to be used.", "comment": "It may be possible for the service definition to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.topic", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.topic", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.topic", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.topic", "path": "ServiceDefinition.topic", "short": "E.g. Education, Treatment, Assessment, etc", "definition": "Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.", "requirements": "Repositories must be able to determine how to categorize the module so that it can be found by topical searches.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DefinitionTopic" } ], "strength": "example", "description": "High-level categorization of the definition, used for searching, sorting, and filtering", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/definition-topic" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.contributor", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.contributor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.contributor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.contributor", "path": "ServiceDefinition.contributor", "short": "A content contributor", "definition": "A contributor to the content of the module, including authors, editors, reviewers, and endorsers.", "requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the knowledge module.", "min": 0, "max": "*", "type": [ { "code": "Contributor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.contact", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.contact", "path": "ServiceDefinition.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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.copyright", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.copyright", "path": "ServiceDefinition.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the service definition and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.copyright" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.relatedArtifact", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.relatedArtifact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.relatedArtifact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.relatedArtifact", "path": "ServiceDefinition.relatedArtifact", "short": "Additional documentation, citations, etc", "definition": "Related resources such as additional documentation, justification, or bibliographic references.", "comment": "Each related resource is either an attachment, or a reference to another resource, but not both.", "requirements": "Modules must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.trigger", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.trigger", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.trigger", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.trigger", "path": "ServiceDefinition.trigger", "short": "\"when\" the module should be invoked", "definition": "The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.", "min": 0, "max": "*", "type": [ { "code": "TriggerDefinition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.dataRequirement", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.dataRequirement", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.dataRequirement", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.dataRequirement", "path": "ServiceDefinition.dataRequirement", "short": "What data is used by the module", "definition": "Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.", "min": 0, "max": "*", "type": [ { "code": "DataRequirement" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ServiceDefinition.operationDefinition", "resource": { "resourceType": "DataElement", "id": "ServiceDefinition.operationDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ServiceDefinition.operationDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ServiceDefinition.operationDefinition", "path": "ServiceDefinition.operationDefinition", "short": "Operation to invoke", "definition": "A reference to the operation that is used to invoke this service.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication", "resource": { "resourceType": "DataElement", "id": "Communication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication", "path": "Communication", "short": "A record of information transmitted from a sender to a receiver", "definition": "An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "com-1", "severity": "error", "human": "Not Done Reason can only be specified if NotDone is \"true\"", "expression": "notDone or notDoneReason.exists().not()", "xpath": "f:notDone/@value=true() or not(exists(f:notDoneReason))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "w5", "map": "workflow.encounter" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.identifier", "resource": { "resourceType": "DataElement", "id": "Communication.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.identifier", "path": "Communication.identifier", "short": "Unique identifier", "definition": "Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.definition", "resource": { "resourceType": "DataElement", "id": "Communication.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.definition", "path": "Communication.definition", "short": "Instantiates protocol or definition", "definition": "A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.definition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.basedOn", "resource": { "resourceType": "DataElement", "id": "Communication.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.basedOn", "path": "Communication.basedOn", "short": "Request fulfilled by this communication", "definition": "An order, proposal or plan fulfilled in whole or in part by this Communication.", "comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc.", "alias": [ "fulfills" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.partOf", "resource": { "resourceType": "DataElement", "id": "Communication.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.partOf", "path": "Communication.partOf", "short": "Part of this action", "definition": "Part of this action.", "alias": [ "container" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.status", "resource": { "resourceType": "DataElement", "id": "Communication.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.status", "path": "Communication.status", "short": "preparation | in-progress | suspended | aborted | completed | entered-in-error", "definition": "The status of the transmission.", "comment": "This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationStatus" } ], "strength": "required", "description": "The status of the communication.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/event-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.notDone", "resource": { "resourceType": "DataElement", "id": "Communication.notDone", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.notDone", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.notDone", "path": "Communication.notDone", "short": "Communication did not occur", "definition": "If true, indicates that the described communication event did not actually occur.", "comment": "This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is.", "requirements": "Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.notDone" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.notDoneReason", "resource": { "resourceType": "DataElement", "id": "Communication.notDoneReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.notDoneReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.notDoneReason", "path": "Communication.notDoneReason", "short": "Why communication did not occur", "definition": "Describes why the communication event did not occur in coded and/or textual form.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "com-1" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationNotDoneReason" } ], "strength": "example", "description": "Codes for the reason why a communication was not done.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/communication-not-done-reason" } }, "mapping": [ { "identity": "workflow", "map": "Event.notDoneReason" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.category", "resource": { "resourceType": "DataElement", "id": "Communication.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.category", "path": "Communication.category", "short": "Message category", "definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc.", "comment": "There may be multiple axes of categorization and one communication may serve multiple purposes.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationCategory" } ], "strength": "example", "description": "Codes for general categories of communications such as alerts, instruction, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/communication-category" } }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.medium", "resource": { "resourceType": "DataElement", "id": "Communication.medium", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.medium", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.medium", "path": "Communication.medium", "short": "A channel of communication", "definition": "A channel that was used for this communication (e.g. email, fax).", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationMedium" } ], "strength": "example", "description": "Codes for communication mediums such as phone, fax, email, in person, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.subject", "resource": { "resourceType": "DataElement", "id": "Communication.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.subject", "path": "Communication.subject", "short": "Focus of message", "definition": "The patient or group that was the focus of this communication.", "alias": [ "patient" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.recipient", "resource": { "resourceType": "DataElement", "id": "Communication.recipient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.recipient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.recipient", "path": "Communication.recipient", "short": "Message recipient", "definition": "The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "mapping": [ { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.topic", "resource": { "resourceType": "DataElement", "id": "Communication.topic", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.topic", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.topic", "path": "Communication.topic", "short": "Focal resources", "definition": "The resources which were responsible for or related to producing this communication.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.context", "resource": { "resourceType": "DataElement", "id": "Communication.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.context", "path": "Communication.context", "short": "Encounter or episode leading to message", "definition": "The encounter within which the communication was sent.", "alias": [ "encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.sent", "resource": { "resourceType": "DataElement", "id": "Communication.sent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.sent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.sent", "path": "Communication.sent", "short": "When sent", "definition": "The time when this communication was sent.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "workflow", "map": "Event.occurrenceDateTime (Invariant: maps to either sent OR received)" }, { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.received", "resource": { "resourceType": "DataElement", "id": "Communication.received", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.received", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.received", "path": "Communication.received", "short": "When received", "definition": "The time when this communication arrived at the destination.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "workflow", "map": "Event.occurrenceDateTime (Invariant: maps to either sent OR received)" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.sender", "resource": { "resourceType": "DataElement", "id": "Communication.sender", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.sender", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.sender", "path": "Communication.sender", "short": "Message sender", "definition": "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.reasonCode", "resource": { "resourceType": "DataElement", "id": "Communication.reasonCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.reasonCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.reasonCode", "path": "Communication.reasonCode", "short": "Indication for message", "definition": "The reason or justification for the communication.", "comment": "Textual reasons can be caprued using reasonCode.text.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationReason" } ], "strength": "example", "description": "Codes for describing reasons for the occurrence of a communication.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } }, "mapping": [ { "identity": "workflow", "map": "Event.reasonCodableConcept" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.reasonReference", "resource": { "resourceType": "DataElement", "id": "Communication.reasonReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.reasonReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.reasonReference", "path": "Communication.reasonReference", "short": "Why was communication done?", "definition": "Indicates another resource whose existence justifies this communication.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.payload", "resource": { "resourceType": "DataElement", "id": "Communication.payload", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.payload", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.payload", "path": "Communication.payload", "short": "Message payload", "definition": "Text, attachment(s), or resource(s) that was communicated to the recipient.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.payload.contentX", "resource": { "resourceType": "DataElement", "id": "Communication.payload.contentX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.payload.contentX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.payload.content[x]", "path": "Communication.payload.content[x]", "short": "Message part content", "definition": "A communicated content (or for multi-part communications, one portion of the communication).", "min": 1, "max": "1", "type": [ { "code": "string" }, { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Communication.note", "resource": { "resourceType": "DataElement", "id": "Communication.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Communication.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Communication.note", "path": "Communication.note", "short": "Comments made about the communication", "definition": "Additional notes or commentary about the communication by the sender, receiver or other interested parties.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Event.note" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition", "path": "ActivityDefinition", "short": "The definition of a specific activity to be taken, independent of any particular patient or context", "definition": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Definition" }, { "identity": "rim", "map": "Act[classCode=ACT; moodCode=DEFN]" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.url", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.url", "path": "ActivityDefinition.url", "short": "Logical URI to reference this activity definition (globally unique)", "definition": "An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the activity definition to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "rim", "map": ".identifier[scope=BUSN;reliability=ISS]" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.identifier", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.identifier", "path": "ActivityDefinition.identifier", "short": "Additional identifier for the activity definition", "definition": "A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", "comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this activity 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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.identifier" }, { "identity": "rim", "map": ".identifier" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.version", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.version", "path": "ActivityDefinition.version", "short": "Business version of the activity definition", "definition": "The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.", "comment": "There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the activity definition with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.name", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.name", "path": "ActivityDefinition.name", "short": "Name for this activity definition (computer friendly)", "definition": "A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", "comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.title", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.title", "path": "ActivityDefinition.title", "short": "Name for this activity definition (human friendly)", "definition": "A short, descriptive, user-friendly title for the activity definition.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" }, { "identity": "rim", "map": ".title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.status", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.status", "path": "ActivityDefinition.status", "short": "draft | active | retired | unknown", "definition": "The status of this activity definition. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of activity definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired activity definition without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "workflow", "map": "Definitition.status (different ValueSet)" }, { "identity": "rim", "map": ".status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.experimental", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.experimental", "path": "ActivityDefinition.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of activity definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental activity definition in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.date", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.date", "path": "ActivityDefinition.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the activity definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.", "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity 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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.publisher", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.publisher", "path": "ActivityDefinition.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the activity definition.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity 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 activity definition. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the activity definition. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher (as string instead of CodeableConcept)" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.description", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.description", "path": "ActivityDefinition.description", "short": "Natural language description of the activity definition", "definition": "A free text natural language description of the activity definition from a consumer's perspective.", "comment": "This description can be used to capture details such as why the activity 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 activity 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.description" }, { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.purpose", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.purpose", "path": "ActivityDefinition.purpose", "short": "Why this activity definition is defined", "definition": "Explaination of why this activity definition is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the activity 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 activity definition.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "rim", "map": ".reasonCode.text" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.usage", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.usage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.usage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.usage", "path": "ActivityDefinition.usage", "short": "Describes the clinical usage of the asset", "definition": "A detailed description of how the asset is used from a clinical perspective.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.approvalDate", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.approvalDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.approvalDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.approvalDate", "path": "ActivityDefinition.approvalDate", "short": "When the activity definition was approved by publisher", "definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "workflow", "map": "Definition.approvalDate" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.lastReviewDate", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.lastReviewDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.lastReviewDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.lastReviewDate", "path": "ActivityDefinition.lastReviewDate", "short": "When the activity definition was last reviewed", "definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.", "comment": "If specified, this is usually after the approval date.", "requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "workflow", "map": "Definition.lastReviewDate" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.effectivePeriod", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.effectivePeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.effectivePeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.effectivePeriod", "path": "ActivityDefinition.effectivePeriod", "short": "When the activity definition is expected to be used", "definition": "The period during which the activity definition content was or is planned to be in active use.", "comment": "The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.", "requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the activity definition are or are expected to be used instead.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.effectivePeriod" }, { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.useContext", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.useContext", "path": "ActivityDefinition.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" }, { "identity": "rim", "map": "N/A (to add?)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.jurisdiction", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.jurisdiction", "path": "ActivityDefinition.jurisdiction", "short": "Intended jurisdiction for activity definition (if applicable)", "definition": "A legal or geographic region in which the activity definition is intended to be used.", "comment": "It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" }, { "identity": "rim", "map": "N/A (to add?)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.topic", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.topic", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.topic", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.topic", "path": "ActivityDefinition.topic", "short": "E.g. Education, Treatment, Assessment, etc", "definition": "Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.", "requirements": "Repositories must be able to determine how to categorize the asset so that it can be found by topical searches.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DefinitionTopic" } ], "strength": "example", "description": "High-level categorization of the definition, used for searching, sorting, and filtering", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/definition-topic" } }, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.contributor", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.contributor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.contributor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.contributor", "path": "ActivityDefinition.contributor", "short": "A content contributor", "definition": "A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.", "requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset.", "min": 0, "max": "*", "type": [ { "code": "Contributor" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT,VRF] {No support yet for editor nor clear whether VRF best corresponds to reviewer or endorser}" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.contact", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.contact", "path": "ActivityDefinition.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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" }, { "identity": "rim", "map": ".participation[typeCode=CALLBCK].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.copyright", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.copyright", "path": "ActivityDefinition.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.copyright" }, { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.relatedArtifact", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.relatedArtifact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.relatedArtifact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.relatedArtifact", "path": "ActivityDefinition.relatedArtifact", "short": "Additional documentation, citations, etc", "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.", "comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.", "requirements": "Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.library", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.library", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.library", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.library", "path": "ActivityDefinition.library", "short": "Logic used by the asset", "definition": "A reference to a Library resource containing any formal logic used by the asset.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Library" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=USE].target[classCode=GROUPER,moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.kind", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.kind", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.kind", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.kind", "path": "ActivityDefinition.kind", "short": "Kind of resource", "definition": "A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.", "comment": "May determine what types of extensions are permitted.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActivityDefinitionKind" } ], "strength": "required", "description": "The kind of activity the definition is describing", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } }, "mapping": [ { "identity": "rim", "map": ".classCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.code", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.code", "path": "ActivityDefinition.code", "short": "Detail type of activity", "definition": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.", "comment": "Tends to be less relevant for activities involving particular products.", "requirements": "Allows matching performed to planned as well as validation against protocols.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActivityDefinitionType" } ], "strength": "example", "description": "Detailed type of the activity; e.g. CBC", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-code" } }, "mapping": [ { "identity": "workflow", "map": "Definition.subjectCodeableConcept" }, { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.timingX", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.timingX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.timingX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.timing[x]", "path": "ActivityDefinition.timing[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": "dateTime" }, { "code": "Period" }, { "code": "Range" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.location", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.location", "path": "ActivityDefinition.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 just identify a type of location.", "requirements": "Helps in planning of activity.", "alias": [ "facility" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=LOC].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.participant", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.participant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.participant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.participant", "path": "ActivityDefinition.participant", "short": "Who should participate in the action", "definition": "Indicates who should participate in performing the action described.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PFM]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.participant.type", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.participant.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.participant.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.participant.type", "path": "ActivityDefinition.participant.type", "short": "patient | practitioner | related-person", "definition": "The type of participant in the action.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActivityParticipantType" } ], "strength": "required", "description": "The type of participant in the activity", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-participant-type" } }, "mapping": [ { "identity": "rim", "map": ".role.classCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.participant.role", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.participant.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.participant.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.participant.role", "path": "ActivityDefinition.participant.role", "short": "E.g. Nurse, Surgeon, Parent, etc", "definition": "The role the participant should play in performing the described action.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActivityParticipantRole" } ], "strength": "example", "description": "Defines roles played by participants for the action", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-participant-role" } }, "mapping": [ { "identity": "rim", "map": ".role.code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.productX", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.productX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.productX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.product[x]", "path": "ActivityDefinition.product[x]", "short": "What's administered/supplied", "definition": "Identifies the food, drug or other product being consumed or supplied in the activity.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" }, { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActivityProduct" } ], "strength": "example", "description": "Code describing the type of substance or medication", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-codes" } }, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=CSM].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.quantity", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.quantity", "path": "ActivityDefinition.quantity", "short": "How much is administered/consumed/supplied", "definition": "Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).", "alias": [ "dose" ], "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mapping": [ { "identity": "rim", "map": ".quantity {for classCode=SPLY]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.dosage", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.dosage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.dosage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.dosage", "path": "ActivityDefinition.dosage", "short": "Detailed dosage instructions", "definition": "Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.", "comment": "If a dosage instruction is used, the definition should not specify timing or quantity.", "min": 0, "max": "*", "type": [ { "code": "Dosage" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM; moodCode=DEFN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.bodySite", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.bodySite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.bodySite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.bodySite", "path": "ActivityDefinition.bodySite", "short": "What part of body to perform on", "definition": "Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).", "comment": "Only used if not implicit in the code found in ProcedureRequest.type.", "requirements": "Knowing where the procedure is made is important for tracking if multiple sites are possible.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "A code that identifies the anatomical location", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "workflow", "map": "Procedure.targetBodySite" }, { "identity": "rim", "map": ".targetSiteCode {for classCode=PROC, SBADM}" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.transform", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.transform", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.transform", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.transform", "path": "ActivityDefinition.transform", "short": "Transform to apply the template", "definition": "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureMap" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.dynamicValue", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.dynamicValue", "path": "ActivityDefinition.dynamicValue", "short": "Dynamic aspects of the definition", "definition": "Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the intent resource that would contain the result.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.description", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.dynamicValue.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.dynamicValue.description", "path": "ActivityDefinition.dynamicValue.description", "short": "Natural language description of the dynamic value", "definition": "A brief, natural language description of the intended semantics of the dynamic value.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.path", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.dynamicValue.path", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.path", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.dynamicValue.path", "path": "ActivityDefinition.dynamicValue.path", "short": "The path to the element to be set dynamically", "definition": "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.language", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.dynamicValue.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.dynamicValue.language", "path": "ActivityDefinition.dynamicValue.language", "short": "Language of the expression", "definition": "The media type of the language for the expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.expression", "resource": { "resourceType": "DataElement", "id": "ActivityDefinition.dynamicValue.expression", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ActivityDefinition.dynamicValue.expression", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ActivityDefinition.dynamicValue.expression", "path": "ActivityDefinition.dynamicValue.expression", "short": "An expression that provides the dynamic value for the customization", "definition": "An expression specifying the value of the customized element.", "comment": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Linkage", "resource": { "resourceType": "DataElement", "id": "Linkage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Linkage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Linkage", "path": "Linkage", "short": "Links records for 'same' item", "definition": "Identifies two or more records (resource instances) that are referring to the same real-world \"occurrence\".", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "lnk-1", "severity": "error", "human": "Must have at least two items", "expression": "item.count()>1", "xpath": "count(f:item)>1" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A - RIM doesn't know how to do this" }, { "identity": "w5", "map": "infrastructure.structure" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Linkage.active", "resource": { "resourceType": "DataElement", "id": "Linkage.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Linkage.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Linkage.active", "path": "Linkage.active", "short": "Whether this linkage assertion is active or not", "definition": "Indicates whether the asserted set of linkages are considered to be \"in effect\".", "comment": "If false, any asserted linkages should not be considered current/relevant/applicable.", "requirements": "Need to be able to mark a linkage record as not to be used because it was created in error.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Linkage.author", "resource": { "resourceType": "DataElement", "id": "Linkage.author", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Linkage.author", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Linkage.author", "path": "Linkage.author", "short": "Who is responsible for linkages", "definition": "Identifies the user or organization responsible for asserting the linkages and who establishes the context for evaluating the nature of each linkage.", "requirements": "\"Primary\" for the same set of linked resources may be different from different user's/organization's perspectives.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Linkage.item", "resource": { "resourceType": "DataElement", "id": "Linkage.item", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Linkage.item", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Linkage.item", "path": "Linkage.item", "short": "Item to be linked", "definition": "Identifies one of the records that is considered to refer to the same real-world occurrence as well as how the items hould be evaluated within the collection of linked items.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "lnk-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Linkage.item.type", "resource": { "resourceType": "DataElement", "id": "Linkage.item.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Linkage.item.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Linkage.item.type", "path": "Linkage.item.type", "short": "source | alternate | historical", "definition": "Distinguishes which item is \"source of truth\" (if any) and which items are no longer considered to be current representations.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "LinkageType" } ], "strength": "required", "description": "Used to distinguish different roles a resource can play within a set of linked resources", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/linkage-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Linkage.item.resource", "resource": { "resourceType": "DataElement", "id": "Linkage.item.resource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Linkage.item.resource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Linkage.item.resource", "path": "Linkage.item.resource", "short": "Resource being linked", "definition": "The resource instance being linked as part of the group.", "min": 1, "max": "1", "type": [ { "code": "Reference" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement", "path": "DeviceUseStatement", "short": "Record of use of a device", "definition": "A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "quick", "map": "DeviceUsePerformanceOccurrence" }, { "identity": "w5", "map": "workflow.order" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.identifier", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.identifier", "path": "DeviceUseStatement.identifier", "short": "External identifier for this record", "definition": "An external identifier for this statement such as an IRI.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "quick", "map": "ClinicalStatement.identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.status", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.status", "path": "DeviceUseStatement.status", "short": "active | completed | entered-in-error +", "definition": "A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.", "comment": "DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).\n\nThis element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceUseStatementStatus" } ], "strength": "required", "description": "A coded concept indicating the current status of a the Device Usage", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/device-statement-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode" }, { "identity": "quick", "map": "…status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.subject", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.subject", "path": "DeviceUseStatement.subject", "short": "Patient using device", "definition": "The patient who used the device.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "mapping": [ { "identity": "quick", "map": "ClinicalStatement.subject" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.whenUsed", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.whenUsed", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.whenUsed", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.whenUsed", "path": "DeviceUseStatement.whenUsed", "short": "Period device was used", "definition": "The time period over which the device was used.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "quick", "map": "Performance.performanceTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.timingX", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.timingX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.timingX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.timing[x]", "path": "DeviceUseStatement.timing[x]", "short": "How often the device was used", "definition": "How often the device was used.", "min": 0, "max": "1", "type": [ { "code": "Timing" }, { "code": "Period" }, { "code": "dateTime" } ], "mapping": [ { "identity": "quick", "map": "DeviceUse.applicationSchedule" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.recordedOn", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.recordedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.recordedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.recordedOn", "path": "DeviceUseStatement.recordedOn", "short": "When statement was recorded", "definition": "The time at which the statement was made/recorded.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "quick", "map": "ClinicalStatement.statementDateTime" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.source", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.source", "path": "DeviceUseStatement.source", "short": "Who made the statement", "definition": "Who reported the device was being used by the patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "mapping": [ { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.device", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.device", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.device", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.device", "path": "DeviceUseStatement.device", "short": "Reference to device used", "definition": "The details of the device used.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "mapping": [ { "identity": "quick", "map": "DeviceUse.device" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.indication", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.indication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.indication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.indication", "path": "DeviceUseStatement.indication", "short": "Why device was used", "definition": "Reason or justification for the use of the device.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "mapping": [ { "identity": "quick", "map": "Action.indication.reason" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.bodySite", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.bodySite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.bodySite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.bodySite", "path": "DeviceUseStatement.bodySite", "short": "Target body site", "definition": "Indicates the site on the subject's body where the device was used ( i.e. the target site).", "requirements": "Knowing where the device is targeted is important for tracking if multiple sites are possible. If more information than just a code is required, use the extension [http://hl7.org/fhir/StructureDefinition/body-site-instance](null.html).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "rim", "map": "targetSiteCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceUseStatement.note", "resource": { "resourceType": "DataElement", "id": "DeviceUseStatement.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceUseStatement.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceUseStatement.note", "path": "DeviceUseStatement.note", "short": "Addition details (comments, instructions)", "definition": "Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "quick", "map": "ClinicalStatement.additionalText" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup", "resource": { "resourceType": "DataElement", "id": "RequestGroup", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup", "path": "RequestGroup", "short": "A group of related requests", "definition": "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.identifier", "resource": { "resourceType": "DataElement", "id": "RequestGroup.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.identifier", "path": "RequestGroup.identifier", "short": "Business identifier", "definition": "Allows a service to provide a unique, business identifier for the request.", "requirements": "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.definition", "resource": { "resourceType": "DataElement", "id": "RequestGroup.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.definition", "path": "RequestGroup.definition", "short": "Instantiates protocol or definition", "definition": "A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.basedOn", "resource": { "resourceType": "DataElement", "id": "RequestGroup.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.basedOn", "path": "RequestGroup.basedOn", "short": "Fulfills plan, proposal, or order", "definition": "A plan, proposal or order that is fulfilled in whole or in part by this request.", "requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.", "alias": [ "fulfills" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.basedOn" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.replaces", "resource": { "resourceType": "DataElement", "id": "RequestGroup.replaces", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.replaces", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.replaces", "path": "RequestGroup.replaces", "short": "Request(s) replaced by this request", "definition": "Completed or terminated request(s) whose function is taken by this new request.", "comment": "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.", "requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.", "alias": [ "supersedes", "prior", "renewed order" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.replaces" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.groupIdentifier", "resource": { "resourceType": "DataElement", "id": "RequestGroup.groupIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.groupIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.groupIdentifier", "path": "RequestGroup.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, prescription or similar form.", "comment": "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.", "requirements": "Some business processes need to know if multiple items were ordered as part of the same \"prescription\" or \"requisition\" for billing or other purposes.", "alias": [ "grouperid", "requisition" ], "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.status", "resource": { "resourceType": "DataElement", "id": "RequestGroup.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.status", "path": "RequestGroup.status", "short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown", "definition": "The current state of the request. For request groups, the status reflects the status of all the requests in the group.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestStatus" } ], "strength": "required", "description": "Codes identifying the stage lifecycle stage of a request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.intent", "resource": { "resourceType": "DataElement", "id": "RequestGroup.intent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.intent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.intent", "path": "RequestGroup.intent", "short": "proposal | plan | order", "definition": "Indicates the level of authority/intentionality associated with the request and where the request 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.", "requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.", "alias": [ "category" ], "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestIntent" } ], "strength": "required", "description": "Codes indicating the degree of authority/intentionality associated with a request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-intent" } }, "mapping": [ { "identity": "workflow", "map": "Request.intent" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.priority", "resource": { "resourceType": "DataElement", "id": "RequestGroup.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.priority", "path": "RequestGroup.priority", "short": "routine | urgent | asap | stat", "definition": "Indicates how quickly the request should be addressed with respect to other requests.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this request should be performed with normal priority", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "description": "Identifies the level of importance to be assigned to actioning the request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.subject", "resource": { "resourceType": "DataElement", "id": "RequestGroup.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.subject", "path": "RequestGroup.subject", "short": "Who the request group is about", "definition": "The subject for which the request group was created.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.context", "resource": { "resourceType": "DataElement", "id": "RequestGroup.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.context", "path": "RequestGroup.context", "short": "Encounter or Episode for the request group", "definition": "Describes the context of the request group, if any.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "mapping": [ { "identity": "workflow", "map": "Request.context" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.authoredOn", "resource": { "resourceType": "DataElement", "id": "RequestGroup.authoredOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.authoredOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.authoredOn", "path": "RequestGroup.authoredOn", "short": "When the request group was authored", "definition": "Indicates when the request group was created.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.author", "resource": { "resourceType": "DataElement", "id": "RequestGroup.author", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.author", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.author", "path": "RequestGroup.author", "short": "Device or practitioner that authored the request group", "definition": "Provides a reference to the author of the request group.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "mapping": [ { "identity": "workflow", "map": "Request.author" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.reasonX", "resource": { "resourceType": "DataElement", "id": "RequestGroup.reasonX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.reasonX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.reason[x]", "path": "RequestGroup.reason[x]", "short": "Reason for the request group", "definition": "Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.reason" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.note", "resource": { "resourceType": "DataElement", "id": "RequestGroup.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.note", "path": "RequestGroup.note", "short": "Additional notes about the response", "definition": "Provides a mechanism to communicate additional information about the response.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Request.note" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action", "path": "RequestGroup.action", "short": "Proposed actions, if any", "definition": "The actions, if any, produced by the evaluation of the artifact.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "rqg-1", "severity": "error", "human": "Must have resource or action but not both", "expression": "resource.exists() != action.exists()", "xpath": "exists(f:resource) != exists(f:action)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.label", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.label", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.label", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.label", "path": "RequestGroup.action.label", "short": "User-visible label for the action (e.g. 1. or A.)", "definition": "A user-visible label for the action.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.title", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.title", "path": "RequestGroup.action.title", "short": "User-visible title", "definition": "The title of the action displayed to a user.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.description", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.description", "path": "RequestGroup.action.description", "short": "Short description of the action", "definition": "A short description of the action used to provide a summary to display to the user.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.textEquivalent", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.textEquivalent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.textEquivalent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.textEquivalent", "path": "RequestGroup.action.textEquivalent", "short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system", "definition": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.code", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.code", "path": "RequestGroup.action.code", "short": "Code representing the meaning of the action or sub-actions", "definition": "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "mapping": [ { "identity": "workflow", "map": "Request.code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.documentation", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.documentation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.documentation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.documentation", "path": "RequestGroup.action.documentation", "short": "Supporting documentation for the intended performer of the action", "definition": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ], "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.condition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.condition", "path": "RequestGroup.action.condition", "short": "Whether or not the action is applicable", "definition": "An expression that describes applicability criteria, or start/stop conditions for the action.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.kind", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.condition.kind", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.kind", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.condition.kind", "path": "RequestGroup.action.condition.kind", "short": "applicability | start | stop", "definition": "The kind of condition.", "comment": "Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe when enter/exit criteria for an action.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionConditionKind" } ], "strength": "required", "description": "The kind of condition for the action", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-condition-kind" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.description", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.condition.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.condition.description", "path": "RequestGroup.action.condition.description", "short": "Natural language description of the condition", "definition": "A brief, natural language description of the condition that effectively communicates the intended semantics.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.language", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.condition.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.condition.language", "path": "RequestGroup.action.condition.language", "short": "Language of the expression", "definition": "The media type of the language for the expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.expression", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.condition.expression", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.condition.expression", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.condition.expression", "path": "RequestGroup.action.condition.expression", "short": "Boolean-valued expression", "definition": "An expression that returns true or false, indicating whether or not the condition is satisfied.", "comment": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.relatedAction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.relatedAction", "path": "RequestGroup.action.relatedAction", "short": "Relationship to another action", "definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction.actionId", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.relatedAction.actionId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction.actionId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.relatedAction.actionId", "path": "RequestGroup.action.relatedAction.actionId", "short": "What action this is related to", "definition": "The element id of the action this is related to.", "min": 1, "max": "1", "type": [ { "code": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction.relationship", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.relatedAction.relationship", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction.relationship", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.relatedAction.relationship", "path": "RequestGroup.action.relatedAction.relationship", "short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end", "definition": "The relationship of this action to the related action.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRelationshipType" } ], "strength": "required", "description": "Defines the types of relationships between actions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-relationship-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction.offsetX", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.relatedAction.offsetX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.relatedAction.offsetX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.relatedAction.offset[x]", "path": "RequestGroup.action.relatedAction.offset[x]", "short": "Time offset for the relationship", "definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", "min": 0, "max": "1", "type": [ { "code": "Duration" }, { "code": "Range" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.timingX", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.timingX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.timingX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.timing[x]", "path": "RequestGroup.action.timing[x]", "short": "When the action should take place", "definition": "An optional value describing when the action should be performed.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Duration" }, { "code": "Range" }, { "code": "Timing" } ], "mapping": [ { "identity": "workflow", "map": "Request.occurrence" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.participant", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.participant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.participant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.participant", "path": "RequestGroup.action.participant", "short": "Who should perform the action", "definition": "The participant that should perform or be responsible for this action.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Person" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.type", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.type", "path": "RequestGroup.action.type", "short": "create | update | remove | fire-event", "definition": "The type of action to perform (create, update, remove).", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionType" } ], "strength": "extensible", "description": "The type of action to be performed", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.groupingBehavior", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.groupingBehavior", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.groupingBehavior", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.groupingBehavior", "path": "RequestGroup.action.groupingBehavior", "short": "visual-group | logical-group | sentence-group", "definition": "Defines the grouping behavior for the action and its children.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionGroupingBehavior" } ], "strength": "required", "description": "Defines organization behavior of a group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.selectionBehavior", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.selectionBehavior", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.selectionBehavior", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.selectionBehavior", "path": "RequestGroup.action.selectionBehavior", "short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more", "definition": "Defines the selection behavior for the action and its children.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionSelectionBehavior" } ], "strength": "required", "description": "Defines selection behavior of a group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.requiredBehavior", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.requiredBehavior", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.requiredBehavior", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.requiredBehavior", "path": "RequestGroup.action.requiredBehavior", "short": "must | could | must-unless-documented", "definition": "Defines the requiredness behavior for the action.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRequiredBehavior" } ], "strength": "required", "description": "Defines requiredness behavior for selecting an action or an action group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-required-behavior" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.precheckBehavior", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.precheckBehavior", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.precheckBehavior", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.precheckBehavior", "path": "RequestGroup.action.precheckBehavior", "short": "yes | no", "definition": "Defines whether the action should usually be preselected.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionPrecheckBehavior" } ], "strength": "required", "description": "Defines selection frequency behavior for an action or group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.cardinalityBehavior", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.cardinalityBehavior", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.cardinalityBehavior", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.cardinalityBehavior", "path": "RequestGroup.action.cardinalityBehavior", "short": "single | multiple", "definition": "Defines whether the action can be selected multiple times.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionCardinalityBehavior" } ], "strength": "required", "description": "Defines behavior for an action or a group for how many times that item may be repeated", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.resource", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.resource", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.resource", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.resource", "path": "RequestGroup.action.resource", "short": "The target of the action", "definition": "The resource that is the target of the action (e.g. CommunicationRequest).", "comment": "The target resource SHALL be a [Request](request.html) resource with a Request.intent set to \"option\".", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "rqg-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/RequestGroup.action.action", "resource": { "resourceType": "DataElement", "id": "RequestGroup.action.action", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/RequestGroup.action.action", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "RequestGroup.action.action", "path": "RequestGroup.action.action", "short": "Sub action", "definition": "Sub actions.", "min": 0, "max": "*", "contentReference": "#RequestGroup.action", "condition": [ "rqg-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest", "resource": { "resourceType": "DataElement", "id": "DeviceRequest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest", "path": "DeviceRequest", "short": "Medical device request", "definition": "Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": "Act[moodCode<=INT]" }, { "identity": "w5", "map": "workflow.order" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.identifier", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.identifier", "path": "DeviceRequest.identifier", "short": "External Request identifier", "definition": "Identifiers assigned to this order by the orderer or by the receiver.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC.2, ORC.3" }, { "identity": "rim", "map": ".identifier" }, { "identity": "quick", "map": "ClinicalStatement.identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.definition", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.definition", "path": "DeviceRequest.definition", "short": "Protocol or definition", "definition": "Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.basedOn", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.basedOn", "path": "DeviceRequest.basedOn", "short": "What request fulfills", "definition": "Plan/proposal/order fulfilled by this request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC.8 (plus others)" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" }, { "identity": "quick", "map": "Proposal.prnReason.reason" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.priorRequest", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.priorRequest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.priorRequest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.priorRequest", "path": "DeviceRequest.priorRequest", "short": "What request replaces", "definition": "The request takes the place of the referenced completed or terminated request(s).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Handled by message location of ORC (ORC.1=RO or RU)" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RPLC].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.groupIdentifier", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.groupIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.groupIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.groupIdentifier", "path": "DeviceRequest.groupIdentifier", "short": "Identifier of composite request", "definition": "Composite request this is part of.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC.4" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.status", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.status", "path": "DeviceRequest.status", "short": "draft | active | suspended | completed | entered-in-error | cancelled", "definition": "The status of the request.", "comment": "This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestStatus" } ], "strength": "required", "description": "Codes representing the status of the request.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-status" } }, "mapping": [ { "identity": "v2", "map": "ORC.5" }, { "identity": "rim", "map": ".status" }, { "identity": "quick", "map": "Action.currentStatus" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.intent", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.intent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.intent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.intent", "path": "DeviceRequest.intent", "short": "proposal | plan | original-order | encoded | reflex-order", "definition": "Whether the request is a proposal, plan, an original order or a reflex order.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestIntent" } ], "strength": "required", "description": "The kind of diagnostic request", "valueSetReference": { "reference": "http://build.fhir.org/valueset-request-intent.html" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.priority", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.priority", "path": "DeviceRequest.priority", "short": "Indicates how quickly the {{title}} should be addressed with respect to other requests", "definition": "Indicates how quickly the {{title}} should be addressed with respect to other requests.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "defaultValueCode": "If missing, normal priority", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "description": "Identifies the level of importance to be assigned to actioning the request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "v2", "map": "TQ1.9" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.codeX", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.codeX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.codeX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.code[x]", "path": "DeviceRequest.code[x]", "short": "Device requested", "definition": "The details of the device to be used.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestCode" } ], "strength": "example", "description": "Codes for devices that can be requested", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/device-kind" } }, "mapping": [ { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".code" }, { "identity": "quick", "map": "DeviceUse.device" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.subject", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.subject", "path": "DeviceRequest.subject", "short": "Focus of request", "definition": "The patient who will use the device.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Accompanying PID segment" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "quick", "map": "ClinicalStatement.subject" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.context", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.context", "path": "DeviceRequest.context", "short": "Encounter or Episode motivating request", "definition": "An encounter that provides additional context in which this request is made.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Accompanying PV1" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]" }, { "identity": "quick", "map": "ClinicalStatement.encounter" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.occurrenceX", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.occurrenceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.occurrenceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.occurrence[x]", "path": "DeviceRequest.occurrence[x]", "short": "Desired time or schedule for use", "definition": "The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Accompanying TQ1/TQ2 segments" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "quick", "map": "DeviceUse.applicationSchedule" }, { "identity": "w5", "map": "when.planned" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.authoredOn", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.authoredOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.authoredOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.authoredOn", "path": "DeviceRequest.authoredOn", "short": "When recorded", "definition": "When the request transitioned to being actionable.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC.9" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "quick", "map": "ClinicalStatement.statementDateTime" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.requester", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.requester", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.requester", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.requester", "path": "DeviceRequest.requester", "short": "Who/what is requesting diagnostics", "definition": "The individual who initiated the request and has responsibility for its activation.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC.12" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.requester.agent", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.requester.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.requester.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.requester.agent", "path": "DeviceRequest.requester.agent", "short": "Individual making the request", "definition": "The device, practitioner, etc. who initiated the request.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC.12" }, { "identity": "rim", "map": ".player" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.requester.onBehalfOf", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.requester.onBehalfOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.requester.onBehalfOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.requester.onBehalfOf", "path": "DeviceRequest.requester.onBehalfOf", "short": "Organization agent is acting for", "definition": "The organization the device or practitioner was acting on behalf of.", "requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.performerType", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.performerType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.performerType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.performerType", "path": "DeviceRequest.performerType", "short": "Fille role", "definition": "Desired type of performer for doing the diagnostic testing.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestParticipantRole" } ], "strength": "example", "description": "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/participant-role" } }, "mapping": [ { "identity": "v2", "map": "PRT" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.performer", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.performer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.performer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.performer", "path": "DeviceRequest.performer", "short": "Requested Filler", "definition": "The desired perfomer for doing the diagnostic testing.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRT" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.reasonCode", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.reasonCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.reasonCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.reasonCode", "path": "DeviceRequest.reasonCode", "short": "Coded Reason for request", "definition": "Reason or justification for the use of this device.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestReason" } ], "strength": "example", "description": "Diagnosis or problem codes justifying the reason for requesting the device.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/condition-code" } }, "mapping": [ { "identity": "v2", "map": "ORC.16" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "quick", "map": "Action.indication.reason" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.reasonReference", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.reasonReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.reasonReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.reasonReference", "path": "DeviceRequest.reasonReference", "short": "Linked Reason for request", "definition": "Reason or justification for the use of this device.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC.16" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.supportingInfo", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.supportingInfo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.supportingInfo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.supportingInfo", "path": "DeviceRequest.supportingInfo", "short": "Additional clinical information", "definition": "Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site).", "requirements": "Knowing where the device is targeted is important for tracking if multiple sites are possible.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "v2", "map": "Accompanying segments" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=PERT].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.note", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.note", "path": "DeviceRequest.note", "short": "Notes or comments", "definition": "Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "v2", "map": "NTE" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]" }, { "identity": "quick", "map": "ClinicalStatement.additionalText" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/DeviceRequest.relevantHistory", "resource": { "resourceType": "DataElement", "id": "DeviceRequest.relevantHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/DeviceRequest.relevantHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "DeviceRequest.relevantHistory", "path": "DeviceRequest.relevantHistory", "short": "Request provenance", "definition": "Key events in the history of the request.", "comment": "This may not include provenances for all versions of the request – only those deemed “relevant” or important.\rThis 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\rAll 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" } ], "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader", "resource": { "resourceType": "DataElement", "id": "MessageHeader", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader", "path": "MessageHeader", "short": "A resource that describes a message that is exchanged between systems", "definition": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "MSH / MSA / ERR" }, { "identity": "rim", "map": "Message" }, { "identity": "w5", "map": "infrastructure.exchange" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.event", "resource": { "resourceType": "DataElement", "id": "MessageHeader.event", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.event", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.event", "path": "MessageHeader.event", "short": "Code for the event this message represents", "definition": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-events\".", "requirements": "Drives the behavior associated with this message.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MessageEvent" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "example", "description": "One of the message events defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/message-events" } }, "mapping": [ { "identity": "v2", "map": "MSH-9.2" }, { "identity": "rim", "map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.destination", "resource": { "resourceType": "DataElement", "id": "MessageHeader.destination", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.destination", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.destination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "MessageDestination" } ], "path": "MessageHeader.destination", "short": "Message destination application(s)", "definition": "The destination application which the message is intended for.", "comment": "There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.", "requirements": "Indicates where message is to be sent for routing purposes. Allows verification of \"am I the intended recipient\".", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./communicationFunction[typeCode=\"RCV\"]" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.destination.name", "resource": { "resourceType": "DataElement", "id": "MessageHeader.destination.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.destination.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.destination.name", "path": "MessageHeader.destination.name", "short": "Name of system", "definition": "Human-readable name for the target system.", "requirements": "May be used for routing of response and/or to support audit.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "MSH-5" }, { "identity": "rim", "map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.destination.target", "resource": { "resourceType": "DataElement", "id": "MessageHeader.destination.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.destination.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.destination.target", "path": "MessageHeader.destination.target", "short": "Particular delivery destination within the destination", "definition": "Identifies the target end system in situations where the initial message transmission is to an intermediary system.", "requirements": "Supports multi-hop routing.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.destination.endpoint", "resource": { "resourceType": "DataElement", "id": "MessageHeader.destination.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.destination.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.destination.endpoint", "path": "MessageHeader.destination.endpoint", "short": "Actual destination address or id", "definition": "Indicates where the message should be routed to.", "comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.", "requirements": "Identifies where to route the message.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "MSH-25 (or MSH-6)" }, { "identity": "rim", "map": "./telecom" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.receiver", "resource": { "resourceType": "DataElement", "id": "MessageHeader.receiver", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.receiver", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.receiver", "path": "MessageHeader.receiver", "short": "Intended \"real-world\" recipient for the data", "definition": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.", "requirements": "Allows routing beyond just the application level.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'" }, { "identity": "rim", "map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.sender", "resource": { "resourceType": "DataElement", "id": "MessageHeader.sender", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.sender", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.sender", "path": "MessageHeader.sender", "short": "Real world sender of the message", "definition": "Identifies the sending system to allow the use of a trust relationship.", "comment": "Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.", "requirements": "Allows routing beyond just the application level.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'" }, { "identity": "rim", "map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.timestamp", "resource": { "resourceType": "DataElement", "id": "MessageHeader.timestamp", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.timestamp", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.timestamp", "path": "MessageHeader.timestamp", "short": "Time that the message was sent", "definition": "The time that the message was sent.", "requirements": "Allows limited detection of out-of-order and delayed transmission. Also supports audit.", "min": 1, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "MSH-7" }, { "identity": "rim", "map": "./creationTime[isNormalDatatype()]" }, { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.enterer", "resource": { "resourceType": "DataElement", "id": "MessageHeader.enterer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.enterer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.enterer", "path": "MessageHeader.enterer", "short": "The source of the data entry", "definition": "The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.", "comment": "Usually only for the request, but can be used in a response.", "requirements": "Need to know for audit/traceback requirements and possibly for authorization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10" }, { "identity": "rim", "map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.author", "resource": { "resourceType": "DataElement", "id": "MessageHeader.author", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.author", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.author", "path": "MessageHeader.author", "short": "The source of the decision", "definition": "The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.", "comment": "Usually only for the request, but can be used in a response.", "requirements": "Need to know for audit/traceback requirements and possibly for authorization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12" }, { "identity": "rim", "map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.source", "resource": { "resourceType": "DataElement", "id": "MessageHeader.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.source", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "MessageSource" } ], "path": "MessageHeader.source", "short": "Message source application", "definition": "The source application from which this message originated.", "requirements": "Allows replies, supports audit.", "min": 1, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "unique(./communicationFunction[typeCode=\"SND\"])" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.source.name", "resource": { "resourceType": "DataElement", "id": "MessageHeader.source.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.source.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.source.name", "path": "MessageHeader.source.name", "short": "Name of system", "definition": "Human-readable name for the source system.", "requirements": "May be used to support audit.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "MSH-3" }, { "identity": "rim", "map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.source.software", "resource": { "resourceType": "DataElement", "id": "MessageHeader.source.software", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.source.software", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.source.software", "path": "MessageHeader.source.software", "short": "Name of software running the system", "definition": "May include configuration or other information useful in debugging.", "requirements": "Supports audit and possibly interface engine behavior.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SFT-3 ( +SFT-1)" }, { "identity": "rim", "map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.source.version", "resource": { "resourceType": "DataElement", "id": "MessageHeader.source.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.source.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.source.version", "path": "MessageHeader.source.version", "short": "Version of software running", "definition": "Can convey versions of multiple systems in situations where a message passes through multiple hands.", "requirements": "Supports audit and possibly interface engine behavior.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SFT-2" }, { "identity": "rim", "map": "(Not supported)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.source.contact", "resource": { "resourceType": "DataElement", "id": "MessageHeader.source.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.source.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.source.contact", "path": "MessageHeader.source.contact", "short": "Human contact for problems", "definition": "An e-mail, phone, website or other contact point to use to resolve issues with message communications.", "requirements": "Allows escalation of technical issues.", "min": 0, "max": "1", "type": [ { "code": "ContactPoint" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(MSH-22?)" }, { "identity": "rim", "map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.source.endpoint", "resource": { "resourceType": "DataElement", "id": "MessageHeader.source.endpoint", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.source.endpoint", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.source.endpoint", "path": "MessageHeader.source.endpoint", "short": "Actual message source address or id", "definition": "Identifies the routing target to send acknowledgements to.", "comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.", "requirements": "Identifies where to send responses, may influence security permissions.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "MSH-24" }, { "identity": "rim", "map": "./telecom[isNormalDatatype()]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.responsible", "resource": { "resourceType": "DataElement", "id": "MessageHeader.responsible", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.responsible", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.responsible", "path": "MessageHeader.responsible", "short": "Final responsibility for event", "definition": "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.", "comment": "Usually only for the request, but can be used in a response.", "requirements": "Need to know for audit/traceback requirements and possibly for authorization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11" }, { "identity": "rim", "map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.reason", "resource": { "resourceType": "DataElement", "id": "MessageHeader.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.reason", "path": "MessageHeader.reason", "short": "Cause of event", "definition": "Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.", "requirements": "Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EventReason" } ], "strength": "example", "description": "Reason for event occurrence", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/message-reason-encounter" } }, "mapping": [ { "identity": "v2", "map": "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication" }, { "identity": "rim", "map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.response", "resource": { "resourceType": "DataElement", "id": "MessageHeader.response", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.response", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.response", "path": "MessageHeader.response", "short": "If this is a reply to prior message", "definition": "Information about the message that this message is a response to. Only present if this message is a response.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "MSA" }, { "identity": "rim", "map": "./conveyedAcknowledgement" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.response.identifier", "resource": { "resourceType": "DataElement", "id": "MessageHeader.response.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.response.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.response.identifier", "path": "MessageHeader.response.identifier", "short": "Id of original message", "definition": "The MessageHeader.id of the message to which this message is a response.", "requirements": "Allows receiver to know what message is being responded to.", "min": 1, "max": "1", "type": [ { "code": "id" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "MSA-2" }, { "identity": "rim", "map": "./acknowledges.id[isNormalDatatype()]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.response.code", "resource": { "resourceType": "DataElement", "id": "MessageHeader.response.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.response.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.response.code", "path": "MessageHeader.response.code", "short": "ok | transient-error | fatal-error", "definition": "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.", "comment": "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.", "requirements": "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResponseType" } ], "strength": "required", "description": "The kind of response to a message", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/response-code" } }, "mapping": [ { "identity": "v2", "map": "MSA-1" }, { "identity": "rim", "map": "./typeCode[isNormalDatatype()]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.response.details", "resource": { "resourceType": "DataElement", "id": "MessageHeader.response.details", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.response.details", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.response.details", "path": "MessageHeader.response.details", "short": "Specific list of hints/warnings/errors", "definition": "Full details of any issues found in the message.", "comment": "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.", "requirements": "Allows the sender of the message to determine what the specific issues are.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ERR" }, { "identity": "rim", "map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/MessageHeader.focus", "resource": { "resourceType": "DataElement", "id": "MessageHeader.focus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/MessageHeader.focus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "MessageHeader.focus", "path": "MessageHeader.focus", "short": "The actual content of the message", "definition": "The actual data of the message - a reference to the root/focus class of the event.", "comment": "The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.", "requirements": "Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation", "path": "ImmunizationRecommendation", "short": "Guidance or advice relating to an immunization", "definition": "A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "VXU_V04" }, { "identity": "rim", "map": "SubstanceAdministration[moodCode=RMD]" }, { "identity": "w5", "map": "clinical.medication" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.identifier", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.identifier", "path": "ImmunizationRecommendation.identifier", "short": "Business identifier", "definition": "A unique identifier assigned to this particular recommendation record.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.patient", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.patient", "path": "ImmunizationRecommendation.patient", "short": "Who this profile is for", "definition": "The patient the recommendations are for.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".partipication[typeCode=SUBJ].role" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation", "path": "ImmunizationRecommendation.recommendation", "short": "Vaccine administration recommendations", "definition": "Vaccine administration recommendations.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "imr-1", "severity": "error", "human": "One of vaccineCode or targetDisease SHALL be present", "expression": "vaccineCode.exists() or targetDisease.exists()", "xpath": "exists(f:vaccineCode) or exists(f:targetDisease)" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.date", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.date", "path": "ImmunizationRecommendation.recommendation.date", "short": "Date recommendation created", "definition": "The date the immunization recommendation was created.", "min": 1, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX-15" }, { "identity": "rim", "map": ".partipication[typeCode=AUTH].time" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.vaccineCode", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.vaccineCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.vaccineCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.vaccineCode", "path": "ImmunizationRecommendation.recommendation.vaccineCode", "short": "Vaccine recommendation applies to", "definition": "Vaccine that pertains to the recommendation.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VaccineCode" } ], "strength": "example", "description": "The type of vaccine administered", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/vaccine-code" } }, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 e { 30956-7 | 38890-0 }" }, { "identity": "rim", "map": ".partipication[typeCode=CSM].role[classCode=ADMM].code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.targetDisease", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.targetDisease", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.targetDisease", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.targetDisease", "path": "ImmunizationRecommendation.recommendation.targetDisease", "short": "Disease to be immunized against", "definition": "The targeted disease for the recommendation.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TargetDisease" } ], "strength": "example", "description": "The disease that the recommended vaccination targets", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease" } }, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 e { 30956-7 | 38890-0 }" }, { "identity": "rim", "map": ".partipication[typeCode=CSM].role[classCode=ADMM].code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.doseNumber", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.doseNumber", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.doseNumber", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.doseNumber", "path": "ImmunizationRecommendation.recommendation.doseNumber", "short": "Recommended dose number", "definition": "The next recommended dose number (e.g. dose 2 is the next recommended dose).", "comment": "May need other dose concepts such as administered vs. valid.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 30973-2" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.forecastStatus", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.forecastStatus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.forecastStatus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.forecastStatus", "path": "ImmunizationRecommendation.recommendation.forecastStatus", "short": "Vaccine administration status", "definition": "Vaccine administration status.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationRecommendationStatus" } ], "strength": "example", "description": "The patient's status with respect to a vaccination protocol", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-status" } }, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 59783-1" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=\"Immunization Forecast Status\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.dateCriterion", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.dateCriterion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.dateCriterion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.dateCriterion", "path": "ImmunizationRecommendation.recommendation.dateCriterion", "short": "Dates governing proposed immunization", "definition": "Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "v2", "map": "OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue" }, { "identity": "rim", "map": ".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.dateCriterion.code", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.dateCriterion.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.dateCriterion.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code", "short": "Type of date", "definition": "Date classification of recommendation. For example, earliest date to give, latest date to give, etc.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationRecommendationDateCriterion" } ], "strength": "example", "description": "Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion" } }, "mapping": [ { "identity": "v2", "map": "OBX-3" }, { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.dateCriterion.value", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.dateCriterion.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.dateCriterion.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.dateCriterion.value", "path": "ImmunizationRecommendation.recommendation.dateCriterion.value", "short": "Recommended date", "definition": "The date whose meaning is specified by dateCriterion.code.", "min": 1, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "v2", "map": "OBX-5" }, { "identity": "rim", "map": ".value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.protocol", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.protocol", "path": "ImmunizationRecommendation.recommendation.protocol", "short": "Protocol used by recommendation", "definition": "Contains information about the protocol under which the vaccine was administered.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.doseSequence", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.protocol.doseSequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.doseSequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.protocol.doseSequence", "path": "ImmunizationRecommendation.recommendation.protocol.doseSequence", "short": "Dose number within sequence", "definition": "Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 30973-2" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.description", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.protocol.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.protocol.description", "path": "ImmunizationRecommendation.recommendation.protocol.description", "short": "Protocol details", "definition": "Contains the description about the protocol under which the vaccine was administered.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 30956-7" }, { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.authority", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.protocol.authority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.authority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.protocol.authority", "path": "ImmunizationRecommendation.recommendation.protocol.authority", "short": "Who is responsible for protocol", "definition": "Indicates the authority who published the protocol. For example, ACIP.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 59779-9" }, { "identity": "rim", "map": ".participation[typeCode=AUT]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.series", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.protocol.series", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.protocol.series", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.protocol.series", "path": "ImmunizationRecommendation.recommendation.protocol.series", "short": "Name of vaccination series", "definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "RXA-5-administered code" }, { "identity": "rim", "map": ".title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.supportingImmunization", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.supportingImmunization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.supportingImmunization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.supportingImmunization", "path": "ImmunizationRecommendation.recommendation.supportingImmunization", "short": "Past immunizations supporting recommendation", "definition": "Immunization event history that supports the status and recommendation.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Immunization" } ], "mapping": [ { "identity": "v2", "map": "? No clear way to associate in HL7 v2 or IG" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=\"immunization\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.supportingPatientInfor", "resource": { "resourceType": "DataElement", "id": "ImmunizationRecommendation.recommendation.supportingPatientInfor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ImmunizationRecommendation.recommendation.supportingPatientInfor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ImmunizationRecommendation.recommendation.supportingPatientInformation", "path": "ImmunizationRecommendation.recommendation.supportingPatientInformation", "short": "Patient observations supporting recommendation", "definition": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" } ], "mapping": [ { "identity": "v2", "map": "OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX'), could contain the reason the vaccine was not administered" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite", "resource": { "resourceType": "DataElement", "id": "BodySite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite", "path": "BodySite", "short": "Specific and identified anatomical location", "definition": "Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.", "alias": [ "anatomical location" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "ActSIte" }, { "identity": "openehr", "map": "Archetype ID openEHR-EHR-CLUSTER.anatomical_location.v1 Concept name Anatomical Location Concept description Record details about an anatomical location. Keywords location, site, anatomical Copyright © openEHR Foundation Purpose To record details about anatomical location. Misuse Not for specifiying unilateral/bilateral occurrence - this is related to an evaluation which perhaps includes multiple locations. Author Author name: Heather Leslie Organization: Ocean Informatics Email: heather.leslie@oceaninformatics.com Date of Origination: 2008-11-10 Translator Norwegian Bokmål: Lars Bitsch-Larsen, Haukeland University Hospital of Bergen, Norway, MD, DEAA, MBA, spec in anesthesia, spec in tropical medicine. Arabic (Syria): Mona Saleh Other contributors Heather Leslie, Ocean Informatics, Australia (Editor) Ian McNicoll, freshEHR Clinical Informatics, United Kingdom (Editor) Dunmail Hodkinson, Black Pear Software Ltd, UK References Use cases: - 5LICS, midclavicular line - L forearm, 2cm anterior to the cubital fossa - Right iliac fossa - 5 cm below L tibial tuberosity - 2 cm medial to R nipple - 4 cm below R costal margin in midclavicular line - R femur - midline nose - medial aspect of R great toe nail." }, { "identity": "w5", "map": "clinical.diagnostics" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite.identifier", "resource": { "resourceType": "DataElement", "id": "BodySite.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite.identifier", "path": "BodySite.identifier", "short": "Bodysite identifier", "definition": "Identifier for this instance of the anatomical location.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "openehr", "map": "Specific location Cluster Optional (0..1) Cardinality: Mandatory, repeating, unordered (1..*)" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite.active", "resource": { "resourceType": "DataElement", "id": "BodySite.active", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite.active", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite.active", "path": "BodySite.active", "short": "Whether this body site record is in active use", "definition": "Whether this body site is in active use.", "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "requirements": "Need to be able to mark a body site entry as not to be used because it was created in error.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite.code", "resource": { "resourceType": "DataElement", "id": "BodySite.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite.code", "path": "BodySite.code", "short": "Named anatomical location", "definition": "Named anatomical location - ideally coded where possible.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": ".targetSiteCode" }, { "identity": "openehr", "map": "Name of location" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite.qualifier", "resource": { "resourceType": "DataElement", "id": "BodySite.qualifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite.qualifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite.qualifier", "path": "BodySite.qualifier", "short": "Modification to location code", "definition": "Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySiteQualifier" } ], "strength": "example", "description": "Concepts modifying the anatomic location", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/bodysite-relative-location" } }, "mapping": [ { "identity": "v2", "map": "No distinct element defined in V2.x. The IHE Radiology Technical Framework directs the use of OBR-15-specimen source to contain laterality for imaging studies." }, { "identity": "rim", "map": ".targetSiteCode" }, { "identity": "openehr", "map": "Combines Side, Numerical identifier, Anatomical plane,and Aspect" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite.description", "resource": { "resourceType": "DataElement", "id": "BodySite.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite.description", "path": "BodySite.description", "short": "Anatomical location description", "definition": "A summary, charactarization or explanation of the anatomic location.", "comment": "This description could include any visual markings used to orientate the viewer e.g. external reference points, special sutures, ink markings.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "openehr", "map": "Description of anatomical location/Visual markings/orientation" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite.image", "resource": { "resourceType": "DataElement", "id": "BodySite.image", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite.image", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite.image", "path": "BodySite.image", "short": "Attached images", "definition": "Image or images used to identify a location.", "min": 0, "max": "*", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target" }, { "identity": "openehr", "map": "Image" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/BodySite.patient", "resource": { "resourceType": "DataElement", "id": "BodySite.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/BodySite.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "BodySite.patient", "path": "BodySite.patient", "short": "Who this is about", "definition": "The person to which the body site belongs.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".scoper or .scoper.playsRole" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance", "resource": { "resourceType": "DataElement", "id": "Provenance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance", "path": "Provenance", "short": "Who, What, When for a set of resources", "definition": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.", "comment": "Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.", "alias": [ "History", "Event", "Activity" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]" }, { "identity": "w3c.prov", "map": "Activity" }, { "identity": "w5", "map": "infrastructure.information" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.target", "resource": { "resourceType": "DataElement", "id": "Provenance.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.target", "path": "Provenance.target", "short": "Target Reference(s) (usually version specific)", "definition": "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.", "comment": "Target references are usually version specific, but may not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.", "min": 1, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity.reference" }, { "identity": "w3c.prov", "map": "Entity Created/Updated" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.period", "resource": { "resourceType": "DataElement", "id": "Provenance.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.period", "path": "Provenance.period", "short": "When the activity occurred", "definition": "The period during which the activity occurred.", "comment": "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": "./effectiveTime[type=IVL_TS]" }, { "identity": "w3c.prov", "map": "Activity.startTime & Activity.endTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.recorded", "resource": { "resourceType": "DataElement", "id": "Provenance.recorded", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.recorded", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.recorded", "path": "Provenance.recorded", "short": "When the activity was recorded / updated", "definition": "The instant of time at which the activity was recorded.", "comment": "This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.", "min": 1, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])" }, { "identity": "fhirauditevent", "map": "AuditEvent.recorded" }, { "identity": "w3c.prov", "map": "Activity.when" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.policy", "resource": { "resourceType": "DataElement", "id": "Provenance.policy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.policy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.policy", "path": "Provenance.policy", "short": "Policy or plan the activity was defined by", "definition": "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.", "comment": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "mapping": [ { "identity": "rim", "map": "./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent.policy" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.location", "resource": { "resourceType": "DataElement", "id": "Provenance.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.location", "path": "Provenance.location", "short": "Where the activity occurred, if relevant", "definition": "Where the activity occurred, if relevant.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "rim", "map": "unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent.location" }, { "identity": "w3c.prov", "map": "Activity.location" }, { "identity": "w5", "map": "where" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.reason", "resource": { "resourceType": "DataElement", "id": "Provenance.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.reason", "path": "Provenance.reason", "short": "Reason the activity is occurring", "definition": "The reason that the activity was taking place.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceReason" } ], "strength": "extensible", "description": "The reason the activity took place.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse" } }, "mapping": [ { "identity": "rim", "map": "unique(./reasonCode)" }, { "identity": "fhirauditevent", "map": "AuditEvent.purposeOfEvent" }, { "identity": "w3c.prov", "map": "Activity.Activity" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.activity", "resource": { "resourceType": "DataElement", "id": "Provenance.activity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.activity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.activity", "path": "Provenance.activity", "short": "Activity that occurred", "definition": "An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceActivity" } ], "strength": "extensible", "description": "The activity that took place.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/provenance-activity-type" } }, "mapping": [ { "identity": "rim", "map": "Act.code" }, { "identity": "fhirauditevent", "map": "AuditEvent.purposeOfEvent" }, { "identity": "w3c.prov", "map": "Activity.Activity" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.agent", "resource": { "resourceType": "DataElement", "id": "Provenance.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.agent", "path": "Provenance.agent", "short": "Actor involved", "definition": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.", "comment": "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.", "requirements": "An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent" }, { "identity": "w3c.prov", "map": "Agent" }, { "identity": "w5", "map": "who" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.agent.role", "resource": { "resourceType": "DataElement", "id": "Provenance.agent.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.agent.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.agent.role", "path": "Provenance.agent.role", "short": "What the agents role was", "definition": "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.", "comment": "For example: author, performer, enterer, attester, doctor, nurse, clerk, etc.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceAgentRole" } ], "strength": "extensible", "description": "The role that a provenance agent played with respect to the activity.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-role-type" } }, "mapping": [ { "identity": "rim", "map": ".role and/or .typecode" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent.role" }, { "identity": "w3c.prov", "map": "Agent.Attribution" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.agent.whoX", "resource": { "resourceType": "DataElement", "id": "Provenance.agent.whoX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.agent.whoX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.agent.who[x]", "path": "Provenance.agent.who[x]", "short": "Who participated", "definition": "The individual, device or organization that participated in the event.", "min": 1, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.agent.onBehalfOfX", "resource": { "resourceType": "DataElement", "id": "Provenance.agent.onBehalfOfX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.agent.onBehalfOfX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.agent.onBehalfOf[x]", "path": "Provenance.agent.onBehalfOf[x]", "short": "Who the agent is representing", "definition": "The individual, device, or organization for whom the change was made.", "min": 0, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": "Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.agent.relatedAgentType", "resource": { "resourceType": "DataElement", "id": "Provenance.agent.relatedAgentType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.agent.relatedAgentType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.agent.relatedAgentType", "path": "Provenance.agent.relatedAgentType", "short": "Type of relationship between agents", "definition": "The type of relationship between agents.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RelatedAgentType" } ], "strength": "example", "description": "Type of relationship between two provenance agents.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-RoleLinkType" } }, "mapping": [ { "identity": "rim", "map": ".typeCode" }, { "identity": "w3c.prov", "map": "type" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.entity", "resource": { "resourceType": "DataElement", "id": "Provenance.entity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.entity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.entity", "path": "Provenance.entity", "short": "An entity used in this activity", "definition": "An entity used in this activity.", "comment": "Multiple userIds may be associated with the same Practitioner or other individual across various appearances, each with distinct privileges.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "./subjectOf" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity" }, { "identity": "w3c.prov", "map": "Entity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.entity.role", "resource": { "resourceType": "DataElement", "id": "Provenance.entity.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.entity.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.entity.role", "path": "Provenance.entity.role", "short": "derivation | revision | quotation | source | removal", "definition": "How the entity was used during the activity.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceEntityRole" } ], "strength": "required", "description": "How an entity was used in an activity.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/provenance-entity-role" } }, "mapping": [ { "identity": "rim", "map": "./typeCode" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity.lifecycle" }, { "identity": "w3c.prov", "map": "Entity.role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.entity.whatX", "resource": { "resourceType": "DataElement", "id": "Provenance.entity.whatX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.entity.whatX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.entity.what[x]", "path": "Provenance.entity.what[x]", "short": "Identity of entity", "definition": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.", "comment": "Identity may be a reference to a resource or to something else, depending on the type.", "min": 1, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" }, { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./text/reference" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity.reference" }, { "identity": "w3c.prov", "map": "Entity.Identity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.entity.agent", "resource": { "resourceType": "DataElement", "id": "Provenance.entity.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.entity.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.entity.agent", "path": "Provenance.entity.agent", "short": "Entity is attributed to this agent", "definition": "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.", "comment": "A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.", "min": 0, "max": "*", "contentReference": "#Provenance.agent", "mapping": [ { "identity": "rim", "map": "./author/role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Provenance.signature", "resource": { "resourceType": "DataElement", "id": "Provenance.signature", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Provenance.signature", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Provenance.signature", "path": "Provenance.signature", "short": "Signature on target", "definition": "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.", "min": 0, "max": "*", "type": [ { "code": "Signature" } ], "mapping": [ { "identity": "rim", "map": "./signatureText" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task", "resource": { "resourceType": "DataElement", "id": "Task", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task", "path": "Task", "short": "A task to be performed", "definition": "A task to be performed.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "inv-1", "severity": "error", "human": "Last modified date must be greater than or equal to authored-on date.", "expression": "lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn", "xpath": "not(exists(f:lastModified/@value)) or not(exists(f:authoredOn/@value)) or f:lastModified/@value >= f:authoredOn/@value" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request, Event" }, { "identity": "rim", "map": "ControlAct[moodCode=INT]" }, { "identity": "w5", "map": "workflow.order" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.identifier", "resource": { "resourceType": "DataElement", "id": "Task.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.identifier", "path": "Task.identifier", "short": "Task Instance Identifier", "definition": "The business identifier for this task.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "workflow", "map": "Request.identifier, Event.identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.definitionX", "resource": { "resourceType": "DataElement", "id": "Task.definitionX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.definitionX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.definition[x]", "path": "Task.definition[x]", "short": "Formal definition of task", "definition": "A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.", "requirements": "Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation) to be associated with a task, enabling automation.", "min": 0, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.definition, Event.definition" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.basedOn", "resource": { "resourceType": "DataElement", "id": "Task.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.basedOn", "path": "Task.basedOn", "short": "Request fulfilled by this task", "definition": "BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.basedOn, Definition.basedOn" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[moodCode=INT]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.groupIdentifier", "resource": { "resourceType": "DataElement", "id": "Task.groupIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.groupIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.groupIdentifier", "path": "Task.groupIdentifier", "short": "Requisition or grouper id", "definition": "An identifier that links together multiple tasks and other requests that were created in the same context.", "requirements": "Billing and/or reporting can be linked to whether multiple requests were created as a single unit.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=INT].id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.partOf", "resource": { "resourceType": "DataElement", "id": "Task.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.partOf", "path": "Task.partOf", "short": "Composite task", "definition": "Task that this particular task is part of.", "comment": "This should usually be 0..1.", "requirements": "Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Task" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=INT]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.status", "resource": { "resourceType": "DataElement", "id": "Task.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.status", "path": "Task.status", "short": "draft | requested | received | accepted | +", "definition": "The current status of the task.", "requirements": "These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskStatus" } ], "strength": "required", "description": "The current status of the task.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/task-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status, Event.status" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.statusReason", "resource": { "resourceType": "DataElement", "id": "Task.statusReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.statusReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.statusReason", "path": "Task.statusReason", "short": "Reason for current status", "definition": "An explanation as to why this task is held, failed, was refused, etc.", "comment": "This applies to the current status. Look at the history of the task to see reasons for past statuses.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskStatusReason" } ], "strength": "example", "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow." }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code=\"status change\"].reasonCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.businessStatus", "resource": { "resourceType": "DataElement", "id": "Task.businessStatus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.businessStatus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.businessStatus", "path": "Task.businessStatus", "short": "E.g. \"Specimen collected\", \"IV prepped\"", "definition": "Contains business-specific nuances of the business state.", "requirements": "There's often a need to track substates of a task - this is often variable by specific workflow implementation.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskBusinessStatus" } ], "strength": "example", "description": "The domain-specific business-contextual sub-state of the task. For example: \"Blood drawn\", \"IV inserted\", \"Awaiting physician signature\", etc." }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"business status\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.intent", "resource": { "resourceType": "DataElement", "id": "Task.intent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.intent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.intent", "path": "Task.intent", "short": "proposal | plan | order +", "definition": "Indicates the \"level\" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.", "comment": "This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.\n\nIn most cases, Tasks will have an intent of \"order\".", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskIntent" } ], "strength": "required", "description": "Distinguishes whether the task is a proposal, plan or full order", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-intent" } }, "mapping": [ { "identity": "workflow", "map": "Request.intent" }, { "identity": "rim", "map": ".moodCode" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.priority", "resource": { "resourceType": "DataElement", "id": "Task.priority", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.priority", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.priority", "path": "Task.priority", "short": "normal | urgent | asap | stat", "definition": "Indicates how quickly the Task should be addressed with respect to other requests.", "requirements": "Used to identify the service level expected while performing a task.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this task should be performed with normal priority", "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskPriority" } ], "strength": "required", "description": "The task's priority", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.code", "resource": { "resourceType": "DataElement", "id": "Task.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.code", "path": "Task.code", "short": "Task Type", "definition": "A name or code (or both) briefly describing what the task involves.", "comment": "The title (eg \"My Tasks\", \"Outstanding Tasks for Patient X\") should go into the code.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskCode" } ], "strength": "example", "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow." }, "mapping": [ { "identity": "workflow", "map": "Request.code, Event.code" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.description", "resource": { "resourceType": "DataElement", "id": "Task.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.description", "path": "Task.description", "short": "Human-readable explanation of task", "definition": "A free-text description of what is to be performed.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.focus", "resource": { "resourceType": "DataElement", "id": "Task.focus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.focus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.focus", "path": "Task.focus", "short": "What task is acting on", "definition": "The request being actioned or the resource being manipulated by this task.", "comment": "If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).", "requirements": "Used to identify the thing to be done.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=SUBJ].target" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.for", "resource": { "resourceType": "DataElement", "id": "Task.for", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.for", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.for", "path": "Task.for", "short": "Beneficiary of the Task", "definition": "The entity who benefits from the performance of the service specified in the task (e.g., the patient).", "requirements": "Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.", "alias": [ "Patient" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.subject, Event.subject" }, { "identity": "rim", "map": ".participation[typeCode=RCT].role" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.context", "resource": { "resourceType": "DataElement", "id": "Task.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.context", "path": "Task.context", "short": "Healthcare event during which this task originated", "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", "requirements": "For some tasks it may be important to know the link between the task or episode of care the task originated within.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.context, Event.context" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.executionPeriod", "resource": { "resourceType": "DataElement", "id": "Task.executionPeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.executionPeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.executionPeriod", "path": "Task.executionPeriod", "short": "Start and end time of execution", "definition": "Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.authoredOn", "resource": { "resourceType": "DataElement", "id": "Task.authoredOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.authoredOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.authoredOn", "path": "Task.authoredOn", "short": "Task Creation Date", "definition": "The date and time this task was created.", "requirements": "Most often used along with lastUpdated to track duration of task to supporting monitoring and management.", "alias": [ "Created Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "condition": [ "inv-1" ], "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.lastModified", "resource": { "resourceType": "DataElement", "id": "Task.lastModified", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.lastModified", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.lastModified", "path": "Task.lastModified", "short": "Task Last Modified Date", "definition": "The date and time of last modification to this task.", "requirements": "Used along with history to track task activity and time in a particular task state. This enables monitoring and management.", "alias": [ "Update Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "condition": [ "inv-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.requester", "resource": { "resourceType": "DataElement", "id": "Task.requester", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.requester", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.requester", "path": "Task.requester", "short": "Who is asking for task to be done", "definition": "The creator of the task.", "requirements": "Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.requester.agent", "resource": { "resourceType": "DataElement", "id": "Task.requester.agent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.requester.agent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.requester.agent", "path": "Task.requester.agent", "short": "Individual asking for task", "definition": "The device, practitioner, etc. who initiated the task.", "alias": [ "Initiator", "Author" ], "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester.agent" }, { "identity": "rim", "map": ".player" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.requester.onBehalfOf", "resource": { "resourceType": "DataElement", "id": "Task.requester.onBehalfOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.requester.onBehalfOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.requester.onBehalfOf", "path": "Task.requester.onBehalfOf", "short": "Organization individual is acting for", "definition": "The organization the device or practitioner was acting on behalf of when they initiated the task.", "requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "workflow", "map": "Request.requester.onBehalfOf" }, { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.performerType", "resource": { "resourceType": "DataElement", "id": "Task.performerType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.performerType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.performerType", "path": "Task.performerType", "short": "requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer", "definition": "The type of participant that can execute the task.", "requirements": "Use to distinguish tasks on different activity queues.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskPerformerType" } ], "strength": "preferred", "description": "The type(s) of task performers allowed", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/task-performer-type" } }, "mapping": [ { "identity": "workflow", "map": "Event.performer.role, Request.performerType" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role.code" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.owner", "resource": { "resourceType": "DataElement", "id": "Task.owner", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.owner", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.owner", "path": "Task.owner", "short": "Responsible individual", "definition": "Individual organization or Device currently responsible for task execution.", "comment": "Tasks may be created with an owner not yet identified.", "requirements": "Identifies who is expected to perform this task.", "alias": [ "Performer", "Executer" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor, Request.performer" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.reason", "resource": { "resourceType": "DataElement", "id": "Task.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.reason", "path": "Task.reason", "short": "Why task is needed", "definition": "A description or code indicating why this task needs to be performed.", "comment": "This should only be included if there is no focus or if it differs from the reason indicated on the focus.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskReason" } ], "strength": "example", "description": "Indicates why the task is needed. E.g. Suspended because patient admitted to hospital." }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode, Event.reasonCodeableConcept" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.note", "resource": { "resourceType": "DataElement", "id": "Task.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.note", "path": "Task.note", "short": "Comments made about the task", "definition": "Free-text information captured about the task as it progresses.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Request.note, Event.note" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value(string)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.relevantHistory", "resource": { "resourceType": "DataElement", "id": "Task.relevantHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.relevantHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.relevantHistory", "path": "Task.relevantHistory", "short": "Key events in history of the Task", "definition": "Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.", "comment": "This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.", "alias": [ "Status History" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance" } ], "mapping": [ { "identity": "workflow", "map": "Request.relevantHistory" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.restriction", "resource": { "resourceType": "DataElement", "id": "Task.restriction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.restriction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.restriction", "path": "Task.restriction", "short": "Constraints on fulfillment tasks", "definition": "If the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.", "requirements": "Sometimes when fulfillment is sought, you don't want full fulfillment.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "Instead of pointing to request, would point to component of request, having these characteristics" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.restriction.repetitions", "resource": { "resourceType": "DataElement", "id": "Task.restriction.repetitions", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.restriction.repetitions", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.restriction.repetitions", "path": "Task.restriction.repetitions", "short": "How many times to repeat", "definition": "Indicates the number of times the requested action should occur.", "requirements": "E.g. order that requests monthly lab tests, fulfillment is sought for 1.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "rim", "map": ".repeatNumber" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.restriction.period", "resource": { "resourceType": "DataElement", "id": "Task.restriction.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.restriction.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.restriction.period", "path": "Task.restriction.period", "short": "When fulfillment sought", "definition": "Over what time-period is fulfillment sought.", "comment": "Note that period.high is the due date representing the time by which the task should be completed.", "requirements": "E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime(IVL<TS>)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.restriction.recipient", "resource": { "resourceType": "DataElement", "id": "Task.restriction.recipient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.restriction.recipient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.restriction.recipient", "path": "Task.restriction.recipient", "short": "For whom is fulfillment sought?", "definition": "For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.input", "resource": { "resourceType": "DataElement", "id": "Task.input", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.input", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.input", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Parameter" } ], "path": "Task.input", "short": "Information used to perform task", "definition": "Additional information that may be needed in the execution of the task.", "requirements": "Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.", "alias": [ "Supporting Information" ], "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "???" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.input.type", "resource": { "resourceType": "DataElement", "id": "Task.input.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.input.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.input.type", "path": "Task.input.type", "short": "Label for the input", "definition": "A code or description indicating how the input is intended to be used as part of the task execution.", "comment": "If referencing a BPMN workflow or Protocol, the \"system\" is the URL for the workflow definition and the code is the \"name\" of the required input.", "requirements": "Inputs are named to enable task automation to bind data and pass it from one task to the next.", "alias": [ "Name" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskInputParameterType" } ], "strength": "example", "description": "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Comparison source\", \"Applicable consent\", \"Concommitent Medications\", etc." }, "mapping": [ { "identity": "rim", "map": "???" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.input.valueX", "resource": { "resourceType": "DataElement", "id": "Task.input.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.input.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.input.value[x]", "path": "Task.input.value[x]", "short": "Content to use in performing the task", "definition": "The value of the input parameter as a basic type.", "min": 1, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "mapping": [ { "identity": "rim", "map": "???" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.output", "resource": { "resourceType": "DataElement", "id": "Task.output", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.output", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.output", "path": "Task.output", "short": "Information produced as part of task", "definition": "Outputs produced by the Task.", "requirements": "Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "???" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.output.type", "resource": { "resourceType": "DataElement", "id": "Task.output.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.output.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.output.type", "path": "Task.output.type", "short": "Label for output", "definition": "The name of the Output parameter.", "requirements": "Outputs are named to enable task automation to bind data and pass it from one task to the next.", "alias": [ "Name" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskOutputParameterType" } ], "strength": "example", "description": "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Identified issues\", \"Preliminary results\", \"Filler order\", \"Final results\", etc." }, "mapping": [ { "identity": "rim", "map": "???" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Task.output.valueX", "resource": { "resourceType": "DataElement", "id": "Task.output.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Task.output.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Task.output.value[x]", "path": "Task.output.value[x]", "short": "Result of output", "definition": "The value of the Output parameter as a basic type.", "requirements": "Task outputs can take any form.", "min": 1, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "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": "Meta" } ], "mapping": [ { "identity": "rim", "map": "???" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire", "resource": { "resourceType": "DataElement", "id": "Questionnaire", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire", "path": "Questionnaire", "short": "A structured set of questions", "definition": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.", "alias": [ "Form", "CRF", "Survey" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "que-2", "severity": "error", "human": "The link ids for groups and questions must be unique within the questionnaire", "expression": "descendants().linkId.isDistinct()", "xpath": "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Observation[moodCode=DEF]" }, { "identity": "w5", "map": "infrastructure.information" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.url", "resource": { "resourceType": "DataElement", "id": "Questionnaire.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.url", "path": "Questionnaire.url", "short": "Logical URI to reference this questionnaire (globally unique)", "definition": "An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".identifier[scope=BUSN;reliability=ISS]" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.identifier", "resource": { "resourceType": "DataElement", "id": "Questionnaire.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.identifier", "path": "Questionnaire.identifier", "short": "Additional identifier for the questionnaire", "definition": "A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.", "comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this questionnaire 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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".identifier" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.version", "resource": { "resourceType": "DataElement", "id": "Questionnaire.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.version", "path": "Questionnaire.version", "short": "Business version of the questionnaire", "definition": "The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", "comment": "There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the questionnaire with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.name", "resource": { "resourceType": "DataElement", "id": "Questionnaire.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.name", "path": "Questionnaire.name", "short": "Name for this questionnaire (computer friendly)", "definition": "A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.", "comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.title", "resource": { "resourceType": "DataElement", "id": "Questionnaire.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.title", "path": "Questionnaire.title", "short": "Name for this questionnaire (human friendly)", "definition": "A short, descriptive, user-friendly title for the questionnaire.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.status", "resource": { "resourceType": "DataElement", "id": "Questionnaire.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.status", "path": "Questionnaire.status", "short": "draft | active | retired | unknown", "definition": "The status of this questionnaire. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of questionnaires that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired questionnaire without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "rim", "map": ".status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.experimental", "resource": { "resourceType": "DataElement", "id": "Questionnaire.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.experimental", "path": "Questionnaire.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of questionnaire that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental questionnaire in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.date", "resource": { "resourceType": "DataElement", "id": "Questionnaire.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.date", "path": "Questionnaire.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the questionnaire was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.", "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. 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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.publisher", "resource": { "resourceType": "DataElement", "id": "Questionnaire.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.publisher", "path": "Questionnaire.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the questionnaire.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. 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 questionnaire. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the questionnaire. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.description", "resource": { "resourceType": "DataElement", "id": "Questionnaire.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.description", "path": "Questionnaire.description", "short": "Natural language description of the questionnaire", "definition": "A free text natural language description of the questionnaire from a consumer's perspective.", "comment": "This description can be used to capture details such as why the questionnaire 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 questionnaire 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.purpose", "resource": { "resourceType": "DataElement", "id": "Questionnaire.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.purpose", "path": "Questionnaire.purpose", "short": "Why this questionnaire is defined", "definition": "Explaination of why this questionnaire is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the questionnaire 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 questionnaire.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "rim", "map": ".reasonCode.text" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.approvalDate", "resource": { "resourceType": "DataElement", "id": "Questionnaire.approvalDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.approvalDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.approvalDate", "path": "Questionnaire.approvalDate", "short": "When the questionnaire was approved by publisher", "definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.lastReviewDate", "resource": { "resourceType": "DataElement", "id": "Questionnaire.lastReviewDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.lastReviewDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.lastReviewDate", "path": "Questionnaire.lastReviewDate", "short": "When the questionnaire was last reviewed", "definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.", "comment": "If specified, this is usually after the approval date.", "requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.effectivePeriod", "resource": { "resourceType": "DataElement", "id": "Questionnaire.effectivePeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.effectivePeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.effectivePeriod", "path": "Questionnaire.effectivePeriod", "short": "When the questionnaire is expected to be used", "definition": "The period during which the questionnaire content was or is planned to be in active use.", "comment": "The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.", "requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the questionnaire are or are expected to be used instead.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.useContext", "resource": { "resourceType": "DataElement", "id": "Questionnaire.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.useContext", "path": "Questionnaire.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.jurisdiction", "resource": { "resourceType": "DataElement", "id": "Questionnaire.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.jurisdiction", "path": "Questionnaire.jurisdiction", "short": "Intended jurisdiction for questionnaire (if applicable)", "definition": "A legal or geographic region in which the questionnaire is intended to be used.", "comment": "It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.contact", "resource": { "resourceType": "DataElement", "id": "Questionnaire.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.contact", "path": "Questionnaire.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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=CALLBCK].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.copyright", "resource": { "resourceType": "DataElement", "id": "Questionnaire.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.copyright", "path": "Questionnaire.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.code", "resource": { "resourceType": "DataElement", "id": "Questionnaire.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.code", "path": "Questionnaire.code", "short": "Concept that represents the overall questionnaire", "definition": "An identifier for this question or group of questions in a particular terminology such as LOINC.", "requirements": "Allows linking of the complete Questionnaire resources to formal terminologies. It's common for \"panels\" of questions to be identified by a code.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireConcept" } ], "strength": "example", "description": "Codes for questionnaires, groups and individual questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.subjectType", "resource": { "resourceType": "DataElement", "id": "Questionnaire.subjectType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.subjectType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.subjectType", "path": "Questionnaire.subjectType", "short": "Resource that can be subject of QuestionnaireResponse", "definition": "The types of subjects that can be the subject of responses created for the questionnaire.", "comment": "If none are specified, then the subject is unlimited.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item", "path": "Questionnaire.item", "short": "Questions and sections within the Questionnaire", "definition": "A particular question, question grouping or display text that is part of the questionnaire.", "comment": "The content of the questionnaire is constructed from an ordered, hierarchical collection of items.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "que-3" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "que-9", "severity": "error", "human": "Read-only can't be specified for \"display\" items", "expression": "type!='display' or readOnly.empty()", "xpath": "not(f:type/@value='display' and f:readOnly)" }, { "key": "que-8", "severity": "error", "human": "Default values can't be specified for groups or display items", "expression": "(type!='group' and type!='display') or initial.empty()", "xpath": "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])" }, { "key": "que-6", "severity": "error", "human": "Required and repeat aren't permitted for display items", "expression": "type!='display' or (required.empty() and repeats.empty())", "xpath": "not(f:type/@value='display' and (f:required or f:repeats))" }, { "key": "que-5", "severity": "error", "human": "Only 'choice' items can have options", "expression": "(type ='choice' or type = 'open-choice') or (options.empty() and option.empty())", "xpath": "f:type/@value=('choice','open-choice') or not(f:option or f:options)" }, { "key": "que-4", "severity": "error", "human": "A question cannot have both option and options", "expression": "option.empty() or options.empty()", "xpath": "not(f:options and f:option)" }, { "key": "que-3", "severity": "error", "human": "Display items cannot have a \"code\" asserted", "expression": "type!='display' or code.empty()", "xpath": "not(f:type/@value='display' and f:code)" }, { "key": "que-10", "severity": "error", "human": "Maximum length can only be declared for simple question types", "expression": "(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()", "xpath": "f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)" }, { "key": "que-1", "severity": "error", "human": "Group items must have nested items, display items cannot have nested items", "expression": "(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())", "xpath": "not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.linkId", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.linkId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.linkId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.linkId", "path": "Questionnaire.item.linkId", "short": "Unique id for item in questionnaire", "definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.", "comment": "This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.", "requirements": "[QuestionnaireResponse](questionnaireresponse.html#) does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.definition", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.definition", "path": "Questionnaire.item.definition", "short": "ElementDefinition - details for the item", "definition": "A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition: \n\n* code (ElementDefinition.code)\n* type (ElementDefinition.type)\n* required (ElementDefinition.min)\n* repeats (ElementDefinition.max)\n* maxLength (ElementDefinition.maxLength)\n* options (ElementDefinition.binding)\n\nAny information provided in these elements on a Questionnaire Item overrides the information from the definition.", "comment": "the URI refers to an ElementDefinition in either a [StructureDefinition](structuredefinition.html#) or a [DataElement](dataelement.html#), and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id [Element.id](element-definitions.html#Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition. Note that [LOINC codes](loinc.html#dataelements) implicitly define DataElement resources.", "requirements": "A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.code", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.code", "path": "Questionnaire.item.code", "short": "Corresponding concept for this item in a terminology", "definition": "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).", "comment": "The value may come from the ElementDefinition referred to by .definition.", "requirements": "Allows linking of groups of questions to formal terminologies.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "condition": [ "que-3" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireConcept" } ], "strength": "example", "description": "Codes for questionnaires, groups and individual questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.prefix", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.prefix", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.prefix", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.prefix", "path": "Questionnaire.item.prefix", "short": "E.g. \"1(a)\", \"2.5.3\"", "definition": "A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.", "comment": "These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed.\n\nTypically these won't be used for \"display\" items, though such use is not prohibited.\n\nSystems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.", "requirements": "Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.", "alias": [ "label" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "Not supported" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.text", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.text", "path": "Questionnaire.item.text", "short": "Primary text for the item", "definition": "The name of a section, the text of a question or text content for a display item.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.type", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.type", "path": "Questionnaire.item.type", "short": "group | display | boolean | decimal | integer | date | dateTime +", "definition": "The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).", "comment": "Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.", "requirements": "Defines the format in which the user is to be prompted for the answer.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireItemType" } ], "strength": "required", "description": "Distinguishes groups from questions and display text and indicates data type for questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/item-type" } }, "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.enableWhen", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.enableWhen", "path": "Questionnaire.item.enableWhen", "short": "Only allow data when", "definition": "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.", "comment": "If multiple repetitions of this extension are present, the item should be enabled when the condition for *any* of the repetitions is true. I.e. treat \"enableWhen\"s as being joined by an \"or\" clause.\n\nThis element is a modifier because if enableWhen is present for an item, \"required\" is ignored unless one of the enableWhen conditions is met.", "requirements": "Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "que-7", "severity": "error", "human": "enableWhen must contain either a 'answer' or a 'hasAnswer' element", "expression": "hasAnswer.exists() xor answer.exists()", "xpath": "count(f:*[starts-with(local-name(.), 'answer')]|self::f:hasAnswer) = 1" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen.question", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.enableWhen.question", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen.question", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.enableWhen.question", "path": "Questionnaire.item.enableWhen.question", "short": "Question that determines whether item is enabled", "definition": "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.", "comment": "If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the \"ancestor\" axis and then the \"preceding\" axis and then the \"following\" axis.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen.hasAnswer", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.enableWhen.hasAnswer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen.hasAnswer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.enableWhen.hasAnswer", "path": "Questionnaire.item.enableWhen.hasAnswer", "short": "Enable when answered or not", "definition": "An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false).", "comment": "If answered=false and answer values are also provided, then they are treated as \"or\". I.e. \"Enable if the question is unanswered or the answer is one of the specified values\". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.).", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "condition": [ "que-7" ], "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen.answerX", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.enableWhen.answerX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.enableWhen.answerX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.enableWhen.answer[x]", "path": "Questionnaire.item.enableWhen.answer[x]", "short": "Value question must have", "definition": "An answer that the referenced question must match in order for the item to be enabled.", "comment": "Multiple answers are treated as \"or\". E.g. Enable if question 1 = A, C or E. \n\nComponents not specified in the answer do not need to match. For example, if enableWhen specifies code + system for a Coding, it is ok if the answer has a \"display\" element. I.e. treat the answer as a 'pattern'.\n\nThe dataType of this element must be the same as the data type of the question being referenced.", "min": 0, "max": "1", "type": [ { "code": "boolean" }, { "code": "decimal" }, { "code": "integer" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "que-7" ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption2" } ], "strength": "example", "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.required", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.required", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.required", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.required", "path": "Questionnaire.item.required", "short": "Whether the item must be included in data results", "definition": "An indication, if true, that the item must be present in a \"completed\" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.", "comment": "Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "condition": [ "que-6" ], "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.repeats", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.repeats", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.repeats", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.repeats", "path": "Questionnaire.item.repeats", "short": "Whether the item may repeat", "definition": "An indication, if true, that the item may occur multiple times in the response, collecting multiple answers answers for questions or multiple sets of answers for groups.", "comment": "If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition or to simply list each of the answers beneath the question. (Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.). The value may come from the ElementDefinition referred to by .definition.", "requirements": "Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "condition": [ "que-6" ], "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.readOnly", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.readOnly", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.readOnly", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.readOnly", "path": "Questionnaire.item.readOnly", "short": "Don't allow human editing", "definition": "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.", "comment": "The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.", "requirements": "Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "condition": [ "que-9" ], "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.maxLength", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.maxLength", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.maxLength", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.maxLength", "path": "Questionnaire.item.maxLength", "short": "No more than this many characters", "definition": "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.", "comment": "For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "condition": [ "que-10" ], "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.options", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.options", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.options", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.options", "path": "Questionnaire.item.options", "short": "Valueset containing permitted answers", "definition": "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.", "comment": "LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](loinc.html#alist). The value may come from the ElementDefinition referred to by .definition.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet" } ], "condition": [ "que-4", "que-5" ], "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.option", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.option", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.option", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.option", "path": "Questionnaire.item.option", "short": "Permitted answer", "definition": "One of the permitted answers for a \"choice\" or \"open-choice\" question.", "comment": "This element can be used when the value set machinery of options is deemed too cumbersome or when there's a need to capture options that are not codes.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "que-4", "que-5" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.option.valueX", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.option.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.option.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.option.value[x]", "path": "Questionnaire.item.option.value[x]", "short": "Answer value", "definition": "A potential answer that's allowed as the answer to this question.", "comment": "The data type of the value must agree with the item.type.", "min": 1, "max": "1", "type": [ { "code": "integer" }, { "code": "date" }, { "code": "time" }, { "code": "string" }, { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption" } ], "strength": "example", "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.initialX", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.initialX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.initialX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.initial[x]", "path": "Questionnaire.item.initial[x]", "short": "Default value when item is first rendered", "definition": "The value that should be defaulted when initially rendering the questionnaire for user input.", "comment": "The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that default values can influence results.\n\nThe data type of initial[x] must agree with the item.type.", "requirements": "In some workflows, having defaults saves time.", "min": 0, "max": "1", "type": [ { "code": "boolean" }, { "code": "decimal" }, { "code": "integer" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "que-8" ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption2" } ], "strength": "example", "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Questionnaire.item.item", "resource": { "resourceType": "DataElement", "id": "Questionnaire.item.item", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Questionnaire.item.item", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Questionnaire.item.item", "path": "Questionnaire.item.item", "short": "Nested questionnaire items", "definition": "Text, questions and other groups to be nested beneath a question or group.", "comment": "There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.", "requirements": "Reports can consist of complex nested groups.", "min": 0, "max": "*", "contentReference": "#Questionnaire.item", "condition": [ "que-1" ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit", "path": "ExplanationOfBenefit", "short": "Explanation of Benefit resource", "definition": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", "alias": [ "EOB" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "w5", "map": "financial.other" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.identifier", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.identifier", "path": "ExplanationOfBenefit.identifier", "short": "Business Identifier", "definition": "The EOB Business Identifier.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.status", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.status", "path": "ExplanationOfBenefit.status", "short": "active | cancelled | draft | entered-in-error", "definition": "The status of the resource instance.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ExplanationOfBenefitStatus" } ], "strength": "required", "description": "A code specifying the state of the resource instance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/explanationofbenefit-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.type", "path": "ExplanationOfBenefit.type", "short": "Type or discipline", "definition": "The category of claim, eg, oral, pharmacy, vision, insitutional, professional.", "comment": "Affects which fields and value sets are used.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ClaimType" } ], "strength": "required", "description": "The type or discipline-style of the claim", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-type" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.subType", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.subType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.subType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.subType", "path": "ExplanationOfBenefit.subType", "short": "Finer grained claim type information", "definition": "A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.", "comment": "This may contain the local bill type codes such as the US UB-04 bill type code.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ClaimSubType" } ], "strength": "example", "description": "A more granulat claim typecode", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-subtype" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.patient", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.patient", "path": "ExplanationOfBenefit.patient", "short": "The subject of the Products and Services", "definition": "Patient Resource.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "mapping": [ { "identity": "cdanetv4", "map": "C06,C07,C08, C05, C04" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.billablePeriod", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.billablePeriod", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.billablePeriod", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.billablePeriod", "path": "ExplanationOfBenefit.billablePeriod", "short": "Period for charge submission", "definition": "The billable period for which charges are being submitted.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.created", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.created", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.created", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.created", "path": "ExplanationOfBenefit.created", "short": "Creation date", "definition": "The date when the EOB was created.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.enterer", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.enterer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.enterer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.enterer", "path": "ExplanationOfBenefit.enterer", "short": "Author", "definition": "The person who created the explanation of benefit.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "mapping": [ { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurer", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.insurer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.insurer", "path": "ExplanationOfBenefit.insurer", "short": "Insurer responsible for the EOB", "definition": "The insurer which is responsible for the explanation of benefit.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "cdanetv4", "map": "B02" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.provider", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.provider", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.provider", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.provider", "path": "ExplanationOfBenefit.provider", "short": "Responsible provider for the claim", "definition": "The provider which is responsible for the claim.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "mapping": [ { "identity": "cdanetv4", "map": "B02" }, { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.organization", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.organization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.organization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.organization", "path": "ExplanationOfBenefit.organization", "short": "Responsible organization for the claim", "definition": "The provider which is responsible for the claim.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "cdanetv4", "map": "B02" }, { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.referral", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.referral", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.referral", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.referral", "path": "ExplanationOfBenefit.referral", "short": "Treatment Referral", "definition": "The referral resource which lists the date, practitioner, reason and other supporting information.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" } ], "mapping": [ { "identity": "cdanetv4", "map": "B05" }, { "identity": "w5", "map": "who.cause" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.facility", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.facility", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.facility", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.facility", "path": "ExplanationOfBenefit.facility", "short": "Servicing Facility", "definition": "Facility where the services were provided.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "w5", "map": "where" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.claim", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.claim", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.claim", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.claim", "path": "ExplanationOfBenefit.claim", "short": "Claim reference", "definition": "The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Claim" } ], "mapping": [ { "identity": "cdanetv4", "map": "A02|G01" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.claimResponse", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.claimResponse", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.claimResponse", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.claimResponse", "path": "ExplanationOfBenefit.claimResponse", "short": "Claim response reference", "definition": "The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse" } ], "mapping": [ { "identity": "cdanetv4", "map": "A02|G01" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.outcome", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.outcome", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.outcome", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.outcome", "path": "ExplanationOfBenefit.outcome", "short": "complete | error | partial", "definition": "Processing outcome errror, partial or complete processing.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RemittanceOutcome" } ], "strength": "example", "description": "The result of the claim processing", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/remittance-outcome" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.disposition", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.disposition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.disposition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.disposition", "path": "ExplanationOfBenefit.disposition", "short": "Disposition Message", "definition": "A description of the status of the adjudication.", "comment": "Do we need a disposition code?", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.related", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.related", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "RelatedClaim" } ], "path": "ExplanationOfBenefit.related", "short": "Related Claims which may be revelant to processing this claim", "definition": "Other claims which are related to this claim such as prior claim versions or for related services.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related.claim", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.related.claim", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related.claim", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.related.claim", "path": "ExplanationOfBenefit.related.claim", "short": "Reference to the related claim", "definition": "Other claims which are related to this claim such as prior claim versions or for related services.", "comment": "Do we need a relationship code?", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Claim" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related.relationship", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.related.relationship", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related.relationship", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.related.relationship", "path": "ExplanationOfBenefit.related.relationship", "short": "How the reference claim is related", "definition": "For example prior or umbrella.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RelatedClaimRelationship" } ], "strength": "example", "description": "Relationship of this claim to a related Claim", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/related-claim-relationship" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related.reference", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.related.reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.related.reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.related.reference", "path": "ExplanationOfBenefit.related.reference", "short": "Related file or case reference", "definition": "An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # .", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.prescription", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.prescription", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.prescription", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.prescription", "path": "ExplanationOfBenefit.prescription", "short": "Prescription authorizing services or products", "definition": "Prescription to support the dispensing of Pharmacy or Vision products.", "requirements": "For type=Pharmacy and Vision only.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.originalPrescription", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.originalPrescription", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.originalPrescription", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.originalPrescription", "path": "ExplanationOfBenefit.originalPrescription", "short": "Original prescription if superceded by fulfiller", "definition": "Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payee", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payee", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Payee" } ], "path": "ExplanationOfBenefit.payee", "short": "Party to be paid any benefits payable", "definition": "The party to be reimbursed for the services.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "cdanetv4", "map": "F02" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payee.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payee.type", "path": "ExplanationOfBenefit.payee.type", "short": "Type of party: Subscriber, Provider, other", "definition": "Type of Party to be reimbursed: Subscriber, provider, other.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PayeeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "example", "description": "A code for the party to be reimbursed.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/payeetype" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee.resourceType", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payee.resourceType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee.resourceType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payee.resourceType", "path": "ExplanationOfBenefit.payee.resourceType", "short": "organization | patient | practitioner | relatedperson", "definition": "organization | patient | practitioner | relatedperson.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PayeeResourceType" } ], "strength": "required", "description": "The type of payee Resource", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-type-link" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee.party", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payee.party", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payee.party", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payee.party", "path": "ExplanationOfBenefit.payee.party", "short": "Party to receive the payable", "definition": "Party to be reimbursed: Subscriber, provider, other.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "mapping": [ { "identity": "cdanetv4", "map": "B03, B04" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.information", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.information", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "SupportingInformation" } ], "path": "ExplanationOfBenefit.information", "short": "Exceptions, special considerations, the condition, situation, prior or concurrent issues", "definition": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.", "requirements": "Typically these information codes are required to support the services rendered or the adjudication of the services rendered.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.sequence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.information.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.information.sequence", "path": "ExplanationOfBenefit.information.sequence", "short": "Information instance identifier", "definition": "Sequence of the information element which serves to provide a link.", "requirements": "To provide a reference link.", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.information.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.information.category", "path": "ExplanationOfBenefit.information.category", "short": "General class of information", "definition": "The general class of the information supplied: information; exception; accident, employment; onset, etc.", "comment": "This may contain the local bill type codes such as the US UB-04 bill type code.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "InformationCategory" } ], "strength": "example", "description": "The valuset used for additional information category codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-informationcategory" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.code", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.information.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.information.code", "path": "ExplanationOfBenefit.information.code", "short": "Type of information", "definition": "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication.", "comment": "This may contain the local bill type codes such as the US UB-04 bill type code.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "InformationCode" } ], "strength": "example", "description": "The valuset used for additional information codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-exception" } }, "mapping": [ { "identity": "cdanetv4", "map": "F23" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.timingX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.information.timingX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.timingX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.information.timing[x]", "path": "ExplanationOfBenefit.information.timing[x]", "short": "When it occurred", "definition": "The date when or period to which this information refers.", "min": 0, "max": "1", "type": [ { "code": "date" }, { "code": "Period" } ], "mapping": [ { "identity": "cdanetv4", "map": "F24" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.valueX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.information.valueX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.valueX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.information.value[x]", "path": "ExplanationOfBenefit.information.value[x]", "short": "Additional Data or supporting information", "definition": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", "min": 0, "max": "1", "type": [ { "code": "string" }, { "code": "Quantity" }, { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.reason", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.information.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.information.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.information.reason", "path": "ExplanationOfBenefit.information.reason", "short": "Reason associated with the information", "definition": "For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MissingReason" } ], "strength": "example", "description": "Reason codes for the missing teeth", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/missing-tooth-reason" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.careTeam", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.careTeam", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "CareTeam" } ], "path": "ExplanationOfBenefit.careTeam", "short": "Care Team members", "definition": "The members of the team who provided the overall service as well as their role and whether responsible and qualifications.", "requirements": "Role and Responsible may not be required when there is only a single provider listed.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.sequence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.careTeam.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.careTeam.sequence", "path": "ExplanationOfBenefit.careTeam.sequence", "short": "Number to covey order of careteam", "definition": "Sequence of careteam which serves to order and provide a link.", "requirements": "Required to maintain order of the careteam members.", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.provider", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.careTeam.provider", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.provider", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.careTeam.provider", "path": "ExplanationOfBenefit.careTeam.provider", "short": "Member of the Care Team", "definition": "The members of the team who provided the overall service.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.responsible", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.careTeam.responsible", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.responsible", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.careTeam.responsible", "path": "ExplanationOfBenefit.careTeam.responsible", "short": "Billing practitioner", "definition": "The practitioner who is billing and responsible for the claimed services rendered to the patient.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.role", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.careTeam.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.careTeam.role", "path": "ExplanationOfBenefit.careTeam.role", "short": "Role on the team", "definition": "The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CareTeamRole" } ], "strength": "example", "description": "The role codes for the care team members.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-careteamrole" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.qualification", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.careTeam.qualification", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.careTeam.qualification", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.careTeam.qualification", "path": "ExplanationOfBenefit.careTeam.qualification", "short": "Type, classification or Specialization", "definition": "The qualification which is applicable for this service.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProviderQualification" } ], "strength": "example", "description": "Provider professional qualifications", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/provider-qualification" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.diagnosis", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.diagnosis", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Diagnosis" } ], "path": "ExplanationOfBenefit.diagnosis", "short": "List of Diagnosis", "definition": "Ordered list of patient diagnosis for which care is sought.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.sequence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.diagnosis.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.diagnosis.sequence", "path": "ExplanationOfBenefit.diagnosis.sequence", "short": "Number to covey order of diagnosis", "definition": "Sequence of diagnosis which serves to provide a link.", "requirements": "Required to allow line items to reference the diagnoses.", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.diagnosisX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.diagnosis.diagnosisX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.diagnosisX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.diagnosis.diagnosis[x]", "path": "ExplanationOfBenefit.diagnosis.diagnosis[x]", "short": "Patient's diagnosis", "definition": "The diagnosis.", "requirements": "Required to adjudicate services rendered to condition presented.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ICD10" } ], "strength": "example", "description": "ICD10 Diagnostic codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/icd-10" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.diagnosis.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.diagnosis.type", "path": "ExplanationOfBenefit.diagnosis.type", "short": "Timing or nature of the diagnosis", "definition": "The type of the Diagnosis, for example: admitting, primary, secondary, discharge.", "comment": "Diagnosis are presented in list order to their expected importance: primary, secondary, etc.", "requirements": "Required to adjudicate services rendered to the mandated diagnosis grouping system.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosisType" } ], "strength": "example", "description": "The type of the diagnosis: admitting, principal, discharge", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-diagnosistype" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.packageCode", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.diagnosis.packageCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.diagnosis.packageCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.diagnosis.packageCode", "path": "ExplanationOfBenefit.diagnosis.packageCode", "short": "Package billing code", "definition": "The package billing code, for example DRG, based on the assigned grouping code system.", "requirements": "Required to adjudicate services rendered to the mandated grouping system.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosisRelatedGroup" } ], "strength": "example", "description": "The DRG codes associated with the diagnosis", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.procedure", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.procedure", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Procedure" } ], "path": "ExplanationOfBenefit.procedure", "short": "Procedures performed", "definition": "Ordered list of patient procedures performed to support the adjudication.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure.sequence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.procedure.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.procedure.sequence", "path": "ExplanationOfBenefit.procedure.sequence", "short": "Procedure sequence for reference", "definition": "Sequence of procedures which serves to order and provide a link.", "requirements": "Required to maintain order of the procudures.", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure.date", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.procedure.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.procedure.date", "path": "ExplanationOfBenefit.procedure.date", "short": "When the procedure was performed", "definition": "Date and optionally time the procedure was performed .", "comment": "SB DateTime??", "requirements": "Required to adjudicate services rendered.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure.procedureX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.procedure.procedureX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.procedure.procedureX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.procedure.procedure[x]", "path": "ExplanationOfBenefit.procedure.procedure[x]", "short": "Patient's list of procedures performed", "definition": "The procedure code.", "requirements": "Required to adjudicate services rendered.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ICD10_Procedures" } ], "strength": "example", "description": "ICD10 Procedure codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/icd-10-procedures" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.precedence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.precedence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.precedence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.precedence", "path": "ExplanationOfBenefit.precedence", "short": "Precedence (primary, secondary, etc.)", "definition": "Precedence (primary, secondary, etc.).", "requirements": "Health care programs and insurers are significant payors of health service costs.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurance", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.insurance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.insurance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Insurance" } ], "path": "ExplanationOfBenefit.insurance", "short": "Insurance or medical plan", "definition": "Financial instrument by which payment information for health care.", "requirements": "Health care programs and insurers are significant payors of health service costs.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "v2", "map": "Coverage" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurance.coverage", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.insurance.coverage", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurance.coverage", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.insurance.coverage", "path": "ExplanationOfBenefit.insurance.coverage", "short": "Insurance information", "definition": "Reference to the program or plan identification, underwriter or payor.", "requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Coverage" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurance.preAuthRef", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.insurance.preAuthRef", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.insurance.preAuthRef", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.insurance.preAuthRef", "path": "ExplanationOfBenefit.insurance.preAuthRef", "short": "Pre-Authorization/Determination Reference", "definition": "A list of references from the Insurer to which these services pertain.", "requirements": "To provide any pre=determination or prior authorization reference.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "mapping": [ { "identity": "cdanetv4", "map": "F03" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.accident", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.accident", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Accident" } ], "path": "ExplanationOfBenefit.accident", "short": "Details of an accident", "definition": "An accident which resulted in the need for healthcare services.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident.date", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.accident.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.accident.date", "path": "ExplanationOfBenefit.accident.date", "short": "When the accident occurred", "definition": "Date of an accident which these services are addressing.", "requirements": "Coverage may be dependant on accidents.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "cdanetv4", "map": "F02" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.accident.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.accident.type", "path": "ExplanationOfBenefit.accident.type", "short": "The nature of the accident", "definition": "Type of accident: work, auto, etc.", "requirements": "Coverage may be dependant on the type of accident.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AccidentType" } ], "strength": "required", "description": "Type of accident: work place, auto, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActIncidentCode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident.locationX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.accident.locationX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.accident.locationX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.accident.location[x]", "path": "ExplanationOfBenefit.accident.location[x]", "short": "Accident Place", "definition": "Where the accident occurred.", "min": 0, "max": "1", "type": [ { "code": "Address" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.employmentImpacted", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.employmentImpacted", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.employmentImpacted", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.employmentImpacted", "path": "ExplanationOfBenefit.employmentImpacted", "short": "Period unable to work", "definition": "The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).", "min": 0, "max": "1", "type": [ { "code": "Period" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.hospitalization", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.hospitalization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.hospitalization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.hospitalization", "path": "ExplanationOfBenefit.hospitalization", "short": "Period in hospital", "definition": "The start and optional end dates of when the patient was confined to a treatment center.", "min": 0, "max": "1", "type": [ { "code": "Period" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Item" } ], "path": "ExplanationOfBenefit.item", "short": "Goods and Services", "definition": "First tier of goods and services.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.sequence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.sequence", "path": "ExplanationOfBenefit.item.sequence", "short": "Service instance", "definition": "A service line number.", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "cdanetv4", "map": "F07" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.careTeamLinkId", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.careTeamLinkId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.careTeamLinkId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.careTeamLinkId", "path": "ExplanationOfBenefit.item.careTeamLinkId", "short": "Applicable careteam members", "definition": "Careteam applicable for this service or product line.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.diagnosisLinkId", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.diagnosisLinkId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.diagnosisLinkId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.diagnosisLinkId", "path": "ExplanationOfBenefit.item.diagnosisLinkId", "short": "Applicable diagnoses", "definition": "Diagnosis applicable for this service or product line.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.procedureLinkId", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.procedureLinkId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.procedureLinkId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.procedureLinkId", "path": "ExplanationOfBenefit.item.procedureLinkId", "short": "Applicable procedures", "definition": "Procedures applicable for this service or product line.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.informationLinkId", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.informationLinkId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.informationLinkId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.informationLinkId", "path": "ExplanationOfBenefit.item.informationLinkId", "short": "Applicable exception and supporting information", "definition": "Exceptions, special conditions and supporting information pplicable for this service or product line.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.revenue", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.revenue", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.revenue", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.revenue", "path": "ExplanationOfBenefit.item.revenue", "short": "Revenue or cost center code", "definition": "The type of reveneu or cost center providing the product and/or service.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RevenueCenter" } ], "strength": "example", "description": "Codes for the revenue or cost centers supplying the service and/or products.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.category", "path": "ExplanationOfBenefit.item.category", "short": "Type of service or product", "definition": "Health Care Service Type Codes to identify the classification of service or benefits.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitSubCategory" } ], "strength": "example", "description": "Benefit subcategories such as: oral-basic, major, glasses", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.service", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.service", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.service", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.service", "path": "ExplanationOfBenefit.item.service", "short": "Billing Code", "definition": "If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceProduct" } ], "strength": "example", "description": "Allowable service and product codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-uscls" } }, "mapping": [ { "identity": "cdanetv4", "map": "F06" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.modifier", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.modifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.modifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.modifier", "path": "ExplanationOfBenefit.item.modifier", "short": "Service/Product billing modifiers", "definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.", "requirements": "May impact on adjudication.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Modifiers" } ], "strength": "example", "description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-modifiers" } }, "mapping": [ { "identity": "cdanetv4", "map": "F16 (required field for Oral) and F05" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.programCode", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.programCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.programCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.programCode", "path": "ExplanationOfBenefit.item.programCode", "short": "Program specific reason for item inclusion", "definition": "For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProgramCode" } ], "strength": "example", "description": "Program specific reason codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-program-code" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.servicedX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.servicedX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.servicedX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.serviced[x]", "path": "ExplanationOfBenefit.item.serviced[x]", "short": "Date or dates of Service", "definition": "The date or dates when the enclosed suite of services were performed or completed.", "min": 0, "max": "1", "type": [ { "code": "date" }, { "code": "Period" } ], "mapping": [ { "identity": "cdanetv4", "map": "F09" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.locationX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.locationX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.locationX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.location[x]", "path": "ExplanationOfBenefit.item.location[x]", "short": "Place of service", "definition": "Where the service was provided.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Address" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServicePlace" } ], "strength": "example", "description": "Place where the service is rendered", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-place" } }, "mapping": [ { "identity": "w5", "map": "where" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.quantity", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.quantity", "path": "ExplanationOfBenefit.item.quantity", "short": "Count of Products or Services", "definition": "The number of repetitions of a service or product.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.unitPrice", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.unitPrice", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.unitPrice", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.unitPrice", "path": "ExplanationOfBenefit.item.unitPrice", "short": "Fee, charge or cost per point", "definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "cdanetv4", "map": "F12" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.factor", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.factor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.factor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.factor", "path": "ExplanationOfBenefit.item.factor", "short": "Price scaling factor", "definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.net", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.net", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.net", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.net", "path": "ExplanationOfBenefit.item.net", "short": "Total item cost", "definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.udi", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.udi", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.udi", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.udi", "path": "ExplanationOfBenefit.item.udi", "short": "Unique Device Identifier", "definition": "List of Unique Device Identifiers associated with this line item.", "requirements": "The UDI code and issuer if applicable for the supplied product.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.bodySite", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.bodySite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.bodySite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.bodySite", "path": "ExplanationOfBenefit.item.bodySite", "short": "Service Location", "definition": "Physical service site on the patient (limb, tooth, etc).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "OralSites" } ], "strength": "example", "description": "The code for the teeth, quadrant, sextant and arch", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/tooth" } }, "mapping": [ { "identity": "cdanetv4", "map": "F10" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.subSite", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.subSite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.subSite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.subSite", "path": "ExplanationOfBenefit.item.subSite", "short": "Service Sub-location", "definition": "A region or surface of the site, eg. limb region or tooth surface(s).", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Surface" } ], "strength": "example", "description": "The code for the tooth surface and surface combinations", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/surface" } }, "mapping": [ { "identity": "cdanetv4", "map": "F11" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.encounter", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.encounter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.encounter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.encounter", "path": "ExplanationOfBenefit.item.encounter", "short": "Encounters related to this billed item", "definition": "A billed item may include goods or services provided in multiple encounters.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.noteNumber", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.noteNumber", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.noteNumber", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.noteNumber", "path": "ExplanationOfBenefit.item.noteNumber", "short": "List of note numbers which apply", "definition": "A list of note references to the notes provided below.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.adjudication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.adjudication", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Adjudication" } ], "path": "ExplanationOfBenefit.item.adjudication", "short": "Adjudication details", "definition": "The adjudications results.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.adjudication.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.adjudication.category", "path": "ExplanationOfBenefit.item.adjudication.category", "short": "Adjudication category such as co-pay, eligible, benefit, etc.", "definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Adjudication" } ], "strength": "example", "description": "The adjudication codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/adjudication" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.reason", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.adjudication.reason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.reason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.adjudication.reason", "path": "ExplanationOfBenefit.item.adjudication.reason", "short": "Explanation of Adjudication outcome", "definition": "Adjudication reason such as limit reached.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdjudicationReason" } ], "strength": "example", "description": "Adjudication reason codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/adjudication-reason" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.amount", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.adjudication.amount", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.amount", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.adjudication.amount", "path": "ExplanationOfBenefit.item.adjudication.amount", "short": "Monetary amount", "definition": "Monitory amount associated with the code.", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.value", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.adjudication.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.adjudication.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.adjudication.value", "path": "ExplanationOfBenefit.item.adjudication.value", "short": "Non-monitory value", "definition": "A non-monetary value for example a percentage. Mutually exclusive to the amount element above.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Detail" } ], "path": "ExplanationOfBenefit.item.detail", "short": "Additional items", "definition": "Second tier of goods and services.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.sequence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.sequence", "path": "ExplanationOfBenefit.item.detail.sequence", "short": "Service instance", "definition": "A service line number.", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "cdanetv4", "map": "F07" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.type", "path": "ExplanationOfBenefit.item.detail.type", "short": "Group or type of product or service", "definition": "The type of product or service.", "comment": "ItemType.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ItemType" } ], "strength": "required", "description": "Service, Product, Rx Dispense, Rx Compound etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActInvoiceGroupCode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.revenue", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.revenue", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.revenue", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.revenue", "path": "ExplanationOfBenefit.item.detail.revenue", "short": "Revenue or cost center code", "definition": "The type of reveneu or cost center providing the product and/or service.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RevenueCenter" } ], "strength": "example", "description": "Codes for the revenue or cost centers supplying the service and/or products.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.category", "path": "ExplanationOfBenefit.item.detail.category", "short": "Type of service or product", "definition": "Health Care Service Type Codes to identify the classification of service or benefits.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitSubCategory" } ], "strength": "example", "description": "Benefit subcategories such as: oral-basic, major, glasses", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.service", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.service", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.service", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.service", "path": "ExplanationOfBenefit.item.detail.service", "short": "Billing Code", "definition": "If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceProduct" } ], "strength": "example", "description": "Allowable service and product codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-uscls" } }, "mapping": [ { "identity": "cdanetv4", "map": "F34/F35" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.modifier", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.modifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.modifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.modifier", "path": "ExplanationOfBenefit.item.detail.modifier", "short": "Service/Product billing modifiers", "definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.", "requirements": "May impact on adjudication.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Modifiers" } ], "strength": "example", "description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-modifiers" } }, "mapping": [ { "identity": "cdanetv4", "map": "F16 (required field for Oral) and F05" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.programCode", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.programCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.programCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.programCode", "path": "ExplanationOfBenefit.item.detail.programCode", "short": "Program specific reason for item inclusion", "definition": "For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProgramCode" } ], "strength": "example", "description": "Program specific reason codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-program-code" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.quantity", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.quantity", "path": "ExplanationOfBenefit.item.detail.quantity", "short": "Count of Products or Services", "definition": "The number of repetitions of a service or product.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.unitPrice", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.unitPrice", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.unitPrice", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.unitPrice", "path": "ExplanationOfBenefit.item.detail.unitPrice", "short": "Fee, charge or cost per point", "definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.factor", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.factor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.factor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.factor", "path": "ExplanationOfBenefit.item.detail.factor", "short": "Price scaling factor", "definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.net", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.net", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.net", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.net", "path": "ExplanationOfBenefit.item.detail.net", "short": "Total additional item cost", "definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.udi", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.udi", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.udi", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.udi", "path": "ExplanationOfBenefit.item.detail.udi", "short": "Unique Device Identifier", "definition": "List of Unique Device Identifiers associated with this line item.", "requirements": "The UDI code and issuer if applicable for the supplied product.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.noteNumber", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.noteNumber", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.noteNumber", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.noteNumber", "path": "ExplanationOfBenefit.item.detail.noteNumber", "short": "List of note numbers which apply", "definition": "A list of note references to the notes provided below.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.adjudication", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.adjudication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.adjudication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.adjudication", "path": "ExplanationOfBenefit.item.detail.adjudication", "short": "Detail level adjudication details", "definition": "The adjudications results.", "min": 0, "max": "*", "contentReference": "#ExplanationOfBenefit.item.adjudication" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "SubDetail" } ], "path": "ExplanationOfBenefit.item.detail.subDetail", "short": "Additional items", "definition": "Third tier of goods and services.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.sequence", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.sequence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.sequence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.sequence", "path": "ExplanationOfBenefit.item.detail.subDetail.sequence", "short": "Service instance", "definition": "A service line number.", "min": 1, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "cdanetv4", "map": "F07" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.type", "path": "ExplanationOfBenefit.item.detail.subDetail.type", "short": "Type of product or service", "definition": "The type of product or service.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ItemType" } ], "strength": "required", "description": "Service, Product, Rx Dispense, Rx Compound etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActInvoiceGroupCode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.revenue", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.revenue", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.revenue", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.revenue", "path": "ExplanationOfBenefit.item.detail.subDetail.revenue", "short": "Revenue or cost center code", "definition": "The type of reveneu or cost center providing the product and/or service.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RevenueCenter" } ], "strength": "example", "description": "Codes for the revenue or cost centers supplying the service and/or products.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.category", "path": "ExplanationOfBenefit.item.detail.subDetail.category", "short": "Type of service or product", "definition": "Health Care Service Type Codes to identify the classification of service or benefits.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitSubCategory" } ], "strength": "example", "description": "Benefit subcategories such as: oral-basic, major, glasses", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.service", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.service", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.service", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.service", "path": "ExplanationOfBenefit.item.detail.subDetail.service", "short": "Billing Code", "definition": "A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceProduct" } ], "strength": "example", "description": "Allowable service and product codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-uscls" } }, "mapping": [ { "identity": "cdanetv4", "map": "F34/F35" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.modifier", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.modifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.modifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.modifier", "path": "ExplanationOfBenefit.item.detail.subDetail.modifier", "short": "Service/Product billing modifiers", "definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.", "requirements": "May impact on adjudication.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Modifiers" } ], "strength": "example", "description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-modifiers" } }, "mapping": [ { "identity": "cdanetv4", "map": "F16 (required field for Oral) and F05" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.programCode", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.programCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.programCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.programCode", "path": "ExplanationOfBenefit.item.detail.subDetail.programCode", "short": "Program specific reason for item inclusion", "definition": "For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProgramCode" } ], "strength": "example", "description": "Program specific reason codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-program-code" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.quantity", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.quantity", "path": "ExplanationOfBenefit.item.detail.subDetail.quantity", "short": "Count of Products or Services", "definition": "The number of repetitions of a service or product.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.unitPrice", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.unitPrice", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.unitPrice", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.unitPrice", "path": "ExplanationOfBenefit.item.detail.subDetail.unitPrice", "short": "Fee, charge or cost per point", "definition": "The fee for an addittional service or product or charge.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.factor", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.factor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.factor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.factor", "path": "ExplanationOfBenefit.item.detail.subDetail.factor", "short": "Price scaling factor", "definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.net", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.net", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.net", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.net", "path": "ExplanationOfBenefit.item.detail.subDetail.net", "short": "Net additional item cost", "definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.", "requirements": "If a fee is present the associated product/service code must be present.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "mapping": [ { "identity": "cdanetv4", "map": "F13/F14" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.udi", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.udi", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.udi", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.udi", "path": "ExplanationOfBenefit.item.detail.subDetail.udi", "short": "Unique Device Identifier", "definition": "List of Unique Device Identifiers associated with this line item.", "requirements": "The UDI code and issuer if applicable for the supplied product.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.noteNumber", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.noteNumber", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.noteNumber", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.noteNumber", "path": "ExplanationOfBenefit.item.detail.subDetail.noteNumber", "short": "List of note numbers which apply", "definition": "A list of note references to the notes provided below.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.adjudication", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.item.detail.subDetail.adjudication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.item.detail.subDetail.adjudication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.item.detail.subDetail.adjudication", "path": "ExplanationOfBenefit.item.detail.subDetail.adjudication", "short": "Language if different from the resource", "definition": "The adjudications results.", "min": 0, "max": "*", "contentReference": "#ExplanationOfBenefit.item.adjudication" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "AddedItem" } ], "path": "ExplanationOfBenefit.addItem", "short": "Insurer added line items", "definition": "The first tier service adjudications for payor added services.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.sequenceLinkId", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.sequenceLinkId", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.sequenceLinkId", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.sequenceLinkId", "path": "ExplanationOfBenefit.addItem.sequenceLinkId", "short": "Service instances", "definition": "List of input service items which this service line is intended to replace.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.revenue", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.revenue", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.revenue", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.revenue", "path": "ExplanationOfBenefit.addItem.revenue", "short": "Revenue or cost center code", "definition": "The type of reveneu or cost center providing the product and/or service.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RevenueCenter" } ], "strength": "example", "description": "Codes for the revenue or cost centers supplying the service and/or products.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.category", "path": "ExplanationOfBenefit.addItem.category", "short": "Type of service or product", "definition": "Health Care Service Type Codes to identify the classification of service or benefits.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitSubCategory" } ], "strength": "example", "description": "Benefit subcategories such as: oral-basic, major, glasses", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory" } }, "mapping": [ { "identity": "cdanetv4", "map": "F06" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.service", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.service", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.service", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.service", "path": "ExplanationOfBenefit.addItem.service", "short": "Billing Code", "definition": "If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceProduct" } ], "strength": "example", "description": "Allowable service and product codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-uscls" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.modifier", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.modifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.modifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.modifier", "path": "ExplanationOfBenefit.addItem.modifier", "short": "Service/Product billing modifiers", "definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.", "requirements": "May impact on adjudication.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Modifiers" } ], "strength": "example", "description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-modifiers" } }, "mapping": [ { "identity": "cdanetv4", "map": "F16 (required field for Oral) and F05" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.fee", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.fee", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.fee", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.fee", "path": "ExplanationOfBenefit.addItem.fee", "short": "Professional fee or Product charge", "definition": "The fee charged for the professional service or product.", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.noteNumber", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.noteNumber", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.noteNumber", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.noteNumber", "path": "ExplanationOfBenefit.addItem.noteNumber", "short": "List of note numbers which apply", "definition": "A list of note references to the notes provided below.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.adjudication", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.adjudication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.adjudication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.adjudication", "path": "ExplanationOfBenefit.addItem.adjudication", "short": "Added items adjudication", "definition": "The adjudications results.", "min": 0, "max": "*", "contentReference": "#ExplanationOfBenefit.item.adjudication" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "AddedItemsDetail" } ], "path": "ExplanationOfBenefit.addItem.detail", "short": "Added items details", "definition": "The second tier service adjudications for payor added services.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.revenue", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail.revenue", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.revenue", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail.revenue", "path": "ExplanationOfBenefit.addItem.detail.revenue", "short": "Revenue or cost center code", "definition": "The type of reveneu or cost center providing the product and/or service.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RevenueCenter" } ], "strength": "example", "description": "Codes for the revenue or cost centers supplying the service and/or products.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail.category", "path": "ExplanationOfBenefit.addItem.detail.category", "short": "Type of service or product", "definition": "Health Care Service Type Codes to identify the classification of service or benefits.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitSubCategory" } ], "strength": "example", "description": "Benefit subcategories such as: oral-basic, major, glasses", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory" } }, "mapping": [ { "identity": "cdanetv4", "map": "F06" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.service", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail.service", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.service", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail.service", "path": "ExplanationOfBenefit.addItem.detail.service", "short": "Billing Code", "definition": "A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceProduct" } ], "strength": "example", "description": "Allowable service and product codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/service-uscls" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.modifier", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail.modifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.modifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail.modifier", "path": "ExplanationOfBenefit.addItem.detail.modifier", "short": "Service/Product billing modifiers", "definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.", "requirements": "May impact on adjudication.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Modifiers" } ], "strength": "example", "description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/claim-modifiers" } }, "mapping": [ { "identity": "cdanetv4", "map": "F16 (required field for Oral) and F05" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.fee", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail.fee", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.fee", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail.fee", "path": "ExplanationOfBenefit.addItem.detail.fee", "short": "Professional fee or Product charge", "definition": "The fee charged for the professional service or product.", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.noteNumber", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail.noteNumber", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.noteNumber", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail.noteNumber", "path": "ExplanationOfBenefit.addItem.detail.noteNumber", "short": "List of note numbers which apply", "definition": "A list of note references to the notes provided below.", "min": 0, "max": "*", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.adjudication", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.addItem.detail.adjudication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.addItem.detail.adjudication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.addItem.detail.adjudication", "path": "ExplanationOfBenefit.addItem.detail.adjudication", "short": "Added items detail adjudication", "definition": "The adjudications results.", "min": 0, "max": "*", "contentReference": "#ExplanationOfBenefit.item.adjudication" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.totalCost", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.totalCost", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.totalCost", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.totalCost", "path": "ExplanationOfBenefit.totalCost", "short": "Total Cost of service from the Claim", "definition": "The total cost of the services reported.", "requirements": "This is a check value that the receiver calculates and returns.", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.unallocDeductable", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.unallocDeductable", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.unallocDeductable", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.unallocDeductable", "path": "ExplanationOfBenefit.unallocDeductable", "short": "Unallocated deductable", "definition": "The amount of deductable applied which was not allocated to any particular service line.", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.totalBenefit", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.totalBenefit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.totalBenefit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.totalBenefit", "path": "ExplanationOfBenefit.totalBenefit", "short": "Total benefit payable for the Claim", "definition": "Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable).", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payment", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Payment" } ], "path": "ExplanationOfBenefit.payment", "short": "Payment (if paid)", "definition": "Payment details for the claim if the claim has been paid.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payment.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payment.type", "path": "ExplanationOfBenefit.payment.type", "short": "Partial or Complete", "definition": "Whether this represents partial or complete payment of the claim.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PaymentType" } ], "strength": "example", "description": "The type (partial, complete) of the payment", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/ex-paymenttype" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.adjustment", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payment.adjustment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.adjustment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payment.adjustment", "path": "ExplanationOfBenefit.payment.adjustment", "short": "Payment adjustment for non-Claim issues", "definition": "Adjustment to the payment of this transaction which is not related to adjudication of this transaction.", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.adjustmentReason", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payment.adjustmentReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.adjustmentReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payment.adjustmentReason", "path": "ExplanationOfBenefit.payment.adjustmentReason", "short": "Explanation for the non-claim adjustment", "definition": "Reason for the payment adjustment.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PaymentAdjustmentReason" } ], "strength": "example", "description": "Payment Adjustment reason codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/payment-adjustment-reason" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.date", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payment.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payment.date", "path": "ExplanationOfBenefit.payment.date", "short": "Expected date of Payment", "definition": "Estimated payment date.", "min": 0, "max": "1", "type": [ { "code": "date" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.amount", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payment.amount", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.amount", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payment.amount", "path": "ExplanationOfBenefit.payment.amount", "short": "Payable amount after adjustment", "definition": "Payable less any payment adjustment.", "min": 0, "max": "1", "type": [ { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.identifier", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.payment.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.payment.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.payment.identifier", "path": "ExplanationOfBenefit.payment.identifier", "short": "Identifier of the payment instrument", "definition": "Payment identifer.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "cdanetv4", "map": "G01, B.23" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.form", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.form", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.form", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.form", "path": "ExplanationOfBenefit.form", "short": "Printed Form Identifier", "definition": "The form to be used for printing the content.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Forms" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "example", "description": "The forms codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/forms" } }, "mapping": [ { "identity": "cdanetv4", "map": "G42" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.processNote", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.processNote", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Note" } ], "path": "ExplanationOfBenefit.processNote", "short": "Processing notes", "definition": "Note text.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.number", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.processNote.number", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.number", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.processNote.number", "path": "ExplanationOfBenefit.processNote.number", "short": "Sequence number for this note", "definition": "An integer associated with each note which may be referred to from each service line item.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.processNote.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.processNote.type", "path": "ExplanationOfBenefit.processNote.type", "short": "display | print | printoper", "definition": "The note purpose: Print/Display.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NoteType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The presentation types of notes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/note-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.text", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.processNote.text", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.text", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.processNote.text", "path": "ExplanationOfBenefit.processNote.text", "short": "Note explanitory text", "definition": "The note text.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "cdanetv4", "map": "G32" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.language", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.processNote.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.processNote.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.processNote.language", "path": "ExplanationOfBenefit.processNote.language", "short": "Language if different from the resource", "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.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "BenefitBalance" } ], "path": "ExplanationOfBenefit.benefitBalance", "short": "Balance by Benefit Category", "definition": "Balance by Benefit Category.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.category", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.category", "path": "ExplanationOfBenefit.benefitBalance.category", "short": "Type of services covered", "definition": "Dental, Vision, Medical, Pharmacy, Rehab etc.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitCategory" } ], "strength": "example", "description": "Benefit categories such as: oral, medical, vision etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-category" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.subCategory", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.subCategory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.subCategory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.subCategory", "path": "ExplanationOfBenefit.benefitBalance.subCategory", "short": "Detailed services covered within the type", "definition": "Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitSubCategory" } ], "strength": "example", "description": "Benefit subcategories such as: oral-basic, major, glasses", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.excluded", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.excluded", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.excluded", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.excluded", "path": "ExplanationOfBenefit.benefitBalance.excluded", "short": "Excluded from the plan", "definition": "True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.name", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.name", "path": "ExplanationOfBenefit.benefitBalance.name", "short": "Short name for the benefit", "definition": "A short name or tag for the benefit, for example MED01, or DENT2.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.description", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.description", "path": "ExplanationOfBenefit.benefitBalance.description", "short": "Description of the benefit or services covered", "definition": "A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.network", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.network", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.network", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.network", "path": "ExplanationOfBenefit.benefitBalance.network", "short": "In or out of network", "definition": "Network designation.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitNetwork" } ], "strength": "example", "description": "Code to classify in or out of network services", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-network" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.unit", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.unit", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.unit", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.unit", "path": "ExplanationOfBenefit.benefitBalance.unit", "short": "Individual or family", "definition": "Unit designation: individual or family.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitUnit" } ], "strength": "example", "description": "Unit covered/serviced - individual or family", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-unit" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.term", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.term", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.term", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.term", "path": "ExplanationOfBenefit.benefitBalance.term", "short": "Annual or lifetime", "definition": "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitTerm" } ], "strength": "example", "description": "Coverage unit - annual, lifetime", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-term" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.financial", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.financial", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Benefit" } ], "path": "ExplanationOfBenefit.benefitBalance.financial", "short": "Benefit Summary", "definition": "Benefits Used to date.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial.type", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.financial.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.financial.type", "path": "ExplanationOfBenefit.benefitBalance.financial.type", "short": "Deductable, visits, benefit amount", "definition": "Deductable, visits, benefit amount.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BenefitType" } ], "strength": "example", "description": "Deductable, visits, co-pay, etc.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/benefit-type" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial.allowedX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.financial.allowedX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial.allowedX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.financial.allowed[x]", "path": "ExplanationOfBenefit.benefitBalance.financial.allowed[x]", "short": "Benefits allowed", "definition": "Benefits allowed.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" }, { "code": "string" }, { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial.usedX", "resource": { "resourceType": "DataElement", "id": "ExplanationOfBenefit.benefitBalance.financial.usedX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ExplanationOfBenefit.benefitBalance.financial.usedX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ExplanationOfBenefit.benefitBalance.financial.used[x]", "path": "ExplanationOfBenefit.benefitBalance.financial.used[x]", "short": "Benefits used", "definition": "Benefits used.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" }, { "code": "Money" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy", "resource": { "resourceType": "DataElement", "id": "ResearchStudy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy", "path": "ResearchStudy", "short": "Investigation to increase healthcare-related patient-independent knowledge", "definition": "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.", "comment": "Need to make sure we encompass public health studies.", "alias": [ "Clinical Trial", "Study" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "Observation[classCode=CLNTRL, moodCode=EVN]" }, { "identity": "w5", "map": "clinical.diagnostics" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.identifier", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.identifier", "path": "ResearchStudy.identifier", "short": "Business Identifier for study", "definition": "Identifiers assigned to this research study by the sponsor or other systems.", "requirements": "Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Organization's Unique Protocol ID; Secondary IDs" }, { "identity": "rim", "map": ".identifier" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.title", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.title", "path": "ResearchStudy.title", "short": "Name for this study", "definition": "A short, descriptive user-friendly label for the study.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Brief Title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.protocol", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.protocol", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.protocol", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.protocol", "path": "ResearchStudy.protocol", "short": "Steps followed in executing study", "definition": "The set of steps expected to be performed as part of the execution of the study.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Interventions; Arm/Intervention Cross-Reference" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.partOf", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.partOf", "path": "ResearchStudy.partOf", "short": "Part of larger study", "definition": "A larger research study of which this particular study is a component or step.", "requirements": "Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc.", "alias": [ "container" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ResearchStudy" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.status", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.status", "path": "ResearchStudy.status", "short": "draft | in-progress | suspended | stopped | completed | entered-in-error", "definition": "The current state of the study.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResearchStudyStatus" } ], "strength": "required", "description": "Codes that convey the current status of the research study", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/research-study-status" } }, "mapping": [ { "identity": "rim", "map": ".status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.category", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.category", "path": "ResearchStudy.category", "short": "Classifications for the study", "definition": "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResearchStudyCategory" } ], "strength": "example", "description": "Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc." }, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Study Type; Primary Purpose; Study Phase; Interventional Model; Masking; Allocation; study Classification; Observational Study Model; Time Perspective; Biospecimen Retention" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.focus", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.focus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.focus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.focus", "path": "ResearchStudy.focus", "short": "Drugs, devices, conditions, etc. under study", "definition": "The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResearchStudyFocus" } ], "strength": "example", "description": "Codes for medications, devices, conditions and other interventions" }, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Conditions or Focus of Study" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.contact", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.contact", "path": "ResearchStudy.contact", "short": "Contact details for the study", "definition": "Contact details to assist a user in learning more about or engaging with the study.", "min": 0, "max": "*", "type": [ { "code": "ContactDetail" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Central Contact; Central Contact Backup; Overall Study Officials; Facility Contact & Backup (if Study tied to only one location); Investigators" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.relatedArtifact", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.relatedArtifact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.relatedArtifact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.relatedArtifact", "path": "ResearchStudy.relatedArtifact", "short": "References and dependencies", "definition": "Citations, references and other related documents.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ], "mapping": [ { "identity": "clinicaltrials-gov", "map": "Citations, Links, Available Study Data/Documents" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.keyword", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.keyword", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.keyword", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.keyword", "path": "ResearchStudy.keyword", "short": "Used to search for the study", "definition": "Key terms to aid in searching for or filtering the study.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResearchStudyKeyword" } ], "strength": "example", "description": "Words associated with the study that may be useful in discovery" }, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Keywords" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.jurisdiction", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.jurisdiction", "path": "ResearchStudy.jurisdiction", "short": "Geographic region(s) for study", "definition": "Indicates a country, state or other region where the study is taking place.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.description", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.description", "path": "ResearchStudy.description", "short": "What this is study doing", "definition": "A full description of how the study is being conducted.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "clinicaltrials-gov", "map": "Detailed Description" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.enrollment", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.enrollment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.enrollment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.enrollment", "path": "ResearchStudy.enrollment", "short": "Inclusion & exclusion criteria", "definition": "Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. \" 200 female Europeans between the ages of 20 and 45 with early onset diabetes\".", "comment": "The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource.", "alias": [ "patient" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Enrollment; Number of Groups/Cohorts (= number of \"enrollment\" instances); Groups (Group/Cohort Label = Group.name; Group/Cohort Description = Group.description); Eligibility (Group criteria)" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.period", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.period", "path": "ResearchStudy.period", "short": "When the study began and ended", "definition": "Identifies the start date and the expected (or actual, depending on status) end date for the study.", "requirements": "[The list of types may be constrained as appropriate for the type of event].", "alias": [ "timing" ], "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Study Start Date (start); Study Completion Date (end)" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.sponsor", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.sponsor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.sponsor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.sponsor", "path": "ResearchStudy.sponsor", "short": "Organization responsible for the study", "definition": "The organization responsible for the execution of the study.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Sponsor" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.principalInvestigator", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.principalInvestigator", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.principalInvestigator", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.principalInvestigator", "path": "ResearchStudy.principalInvestigator", "short": "The individual responsible for the study", "definition": "Indicates the individual who has primary oversite of the execution of the study.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Principal Investigator" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.site", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.site", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.site", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.site", "path": "ResearchStudy.site", "short": "Location involved in study execution", "definition": "Clinic, hospital or other healthcare location that is participating in the study.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Facility" }, { "identity": "w5", "map": "where" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.reasonStopped", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.reasonStopped", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.reasonStopped", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.reasonStopped", "path": "ResearchStudy.reasonStopped", "short": "Reason for terminating study early", "definition": "A description and/or code explaining the premature termination of the study.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "mapping": [ { "identity": "clinicaltrials-gov", "map": "Why Study Stopped" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.note", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.note", "path": "ResearchStudy.note", "short": "Comments made about the event", "definition": "Comments made about the event by the performer, subject or other participants.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.arm", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.arm", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.arm", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.arm", "path": "ResearchStudy.arm", "short": "Defined path through the study for a subject", "definition": "Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "clinicaltrials-gov", "map": "Arms" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.arm.name", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.arm.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.arm.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.arm.name", "path": "ResearchStudy.arm.name", "short": "Label for study arm", "definition": "Unique, human-readable label for this arm of the study.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "clinicaltrials-gov", "map": "Arm Label" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.arm.code", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.arm.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.arm.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.arm.code", "path": "ResearchStudy.arm.code", "short": "Categorization of study arm", "definition": "Categorization of study arm, e.g. experimental, active comparator, placebo comparater.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "mapping": [ { "identity": "clinicaltrials-gov", "map": "Arm Type" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ResearchStudy.arm.description", "resource": { "resourceType": "DataElement", "id": "ResearchStudy.arm.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ResearchStudy.arm.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ResearchStudy.arm.description", "path": "ResearchStudy.arm.description", "short": "Short explanation of study path", "definition": "A succinct description of the path through the study that would be followed by a subject adhering to this arm.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "clinicaltrials-gov", "map": "Arm Description" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen", "resource": { "resourceType": "DataElement", "id": "Specimen", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen", "path": "Specimen", "short": "Sample for analysis", "definition": "A sample to be used for analysis.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Role[classCode=SPEC]" }, { "identity": "w5", "map": "clinical.diagnostics" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.identifier", "resource": { "resourceType": "DataElement", "id": "Specimen.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.identifier", "path": "Specimen.identifier", "short": "External Identifier", "definition": "Id for specimen.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SPM-2" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.accessionIdentifier", "resource": { "resourceType": "DataElement", "id": "Specimen.accessionIdentifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.accessionIdentifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.accessionIdentifier", "path": "Specimen.accessionIdentifier", "short": "Identifier assigned by the lab", "definition": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SPM-30 (v2.7+)" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.status", "resource": { "resourceType": "DataElement", "id": "Specimen.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.status", "path": "Specimen.status", "short": "available | unavailable | unsatisfactory | entered-in-error", "definition": "The availability of the specimen.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SpecimenStatus" } ], "strength": "required", "description": "Codes providing the status/availability of a specimen.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/specimen-status" } }, "mapping": [ { "identity": "v2", "map": "SPM-20" }, { "identity": "rim", "map": "status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.type", "resource": { "resourceType": "DataElement", "id": "Specimen.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.type", "path": "Specimen.type", "short": "Kind of material that forms the specimen", "definition": "The kind of material that forms the specimen.", "comment": "The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SpecimenType" } ], "strength": "example", "description": "The type of the specimen.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0487" } }, "mapping": [ { "identity": "v2", "map": "SPM-4 and possibly SPM-5" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.subject", "resource": { "resourceType": "DataElement", "id": "Specimen.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.subject", "path": "Specimen.subject", "short": "Where the specimen came from. This may be from the patient(s) or from the environment or a device", "definition": "Where the specimen came from. This may be from the patient(s) or from the environment or a device.", "requirements": "Must know the subject context.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".scoper or .scoper.playsRole" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.receivedTime", "resource": { "resourceType": "DataElement", "id": "Specimen.receivedTime", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.receivedTime", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.receivedTime", "path": "Specimen.receivedTime", "short": "The time when specimen was received for processing", "definition": "Time when specimen was received for processing or testing.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SPM-18" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.parent", "resource": { "resourceType": "DataElement", "id": "Specimen.parent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.parent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.parent", "path": "Specimen.parent", "short": "Specimen from which this specimen originated", "definition": "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.", "comment": "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Specimen" } ], "mapping": [ { "identity": "rim", "map": ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.request", "resource": { "resourceType": "DataElement", "id": "Specimen.request", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.request", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.request", "path": "Specimen.request", "short": "Why the specimen was collected", "definition": "Details concerning a test or procedure request that required a specimen to be collected.", "comment": "The request may be explicit or implied such with a ProcedureRequest that requires a blood draw.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest" } ], "mapping": [ { "identity": "v2", "map": "ORC? OBR-2/3?" }, { "identity": "rim", "map": "outboundRelationship[typeCode=FLFS].target" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.collection", "resource": { "resourceType": "DataElement", "id": "Specimen.collection", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.collection", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.collection", "path": "Specimen.collection", "short": "Collection details", "definition": "Details concerning the specimen collection.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "v2", "map": "SPM-14" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.collection.collector", "resource": { "resourceType": "DataElement", "id": "Specimen.collection.collector", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.collection.collector", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.collection.collector", "path": "Specimen.collection.collector", "short": "Who collected the specimen", "definition": "Person who collected the specimen.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRT" }, { "identity": "rim", "map": ".participation[typeCode=PFM].role" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.collection.collectedX", "resource": { "resourceType": "DataElement", "id": "Specimen.collection.collectedX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.collection.collectedX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.collection.collected[x]", "path": "Specimen.collection.collected[x]", "short": "Collection time", "definition": "Time when specimen was collected from subject - the physiologically relevant time.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SPM-17" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.collection.quantity", "resource": { "resourceType": "DataElement", "id": "Specimen.collection.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.collection.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.collection.quantity", "path": "Specimen.collection.quantity", "short": "The quantity of specimen collected", "definition": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mapping": [ { "identity": "v2", "map": "SPM-12" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.collection.method", "resource": { "resourceType": "DataElement", "id": "Specimen.collection.method", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.collection.method", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.collection.method", "path": "Specimen.collection.method", "short": "Technique used to perform collection", "definition": "A coded value specifying the technique that is used to perform the procedure.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SpecimenCollectionMethod" } ], "strength": "example", "description": "The technique that is used to perform the procedure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/specimen-collection-method" } }, "mapping": [ { "identity": "v2", "map": "SPM-7" }, { "identity": "rim", "map": ".methodCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.collection.bodySite", "resource": { "resourceType": "DataElement", "id": "Specimen.collection.bodySite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.collection.bodySite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.collection.bodySite", "path": "Specimen.collection.bodySite", "short": "Anatomical collection site", "definition": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", "comment": "If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "v2", "map": "SPM-8 and SPM-9" }, { "identity": "rim", "map": ".targetSiteCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.processing", "resource": { "resourceType": "DataElement", "id": "Specimen.processing", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.processing", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.processing", "path": "Specimen.processing", "short": "Processing and processing step details", "definition": "Details concerning processing and processing steps for the specimen.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.processing.description", "resource": { "resourceType": "DataElement", "id": "Specimen.processing.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.processing.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.processing.description", "path": "Specimen.processing.description", "short": "Textual description of procedure", "definition": "Textual description of procedure.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.processing.procedure", "resource": { "resourceType": "DataElement", "id": "Specimen.processing.procedure", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.processing.procedure", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.processing.procedure", "path": "Specimen.processing.procedure", "short": "Indicates the treatment step applied to the specimen", "definition": "A coded value specifying the procedure used to process the specimen.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SpecimenProcessingProcedure" } ], "strength": "example", "description": "Type indicating the technique used to process the specimen", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/specimen-processing-procedure" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.processing.additive", "resource": { "resourceType": "DataElement", "id": "Specimen.processing.additive", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.processing.additive", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.processing.additive", "path": "Specimen.processing.additive", "short": "Material used in the processing step", "definition": "Material used in the processing step.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "mapping": [ { "identity": "v2", "map": "SPM-6" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=ADTV].code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.processing.timeX", "resource": { "resourceType": "DataElement", "id": "Specimen.processing.timeX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.processing.timeX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.processing.time[x]", "path": "Specimen.processing.time[x]", "short": "Date and time of specimen processing", "definition": "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.container", "resource": { "resourceType": "DataElement", "id": "Specimen.container", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.container", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.container", "path": "Specimen.container", "short": "Direct container of specimen (tube/slide, etc.)", "definition": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".player.scopingRole[classCode=CONT].scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.container.identifier", "resource": { "resourceType": "DataElement", "id": "Specimen.container.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.container.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.container.identifier", "path": "Specimen.container.identifier", "short": "Id for the container", "definition": "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "SAC-3" }, { "identity": "rim", "map": ".id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.container.description", "resource": { "resourceType": "DataElement", "id": "Specimen.container.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.container.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.container.description", "path": "Specimen.container.description", "short": "Textual description of the container", "definition": "Textual description of the container.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".desc" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.container.type", "resource": { "resourceType": "DataElement", "id": "Specimen.container.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.container.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.container.type", "path": "Specimen.container.type", "short": "Kind of container directly associated with specimen", "definition": "The type of container associated with the specimen (e.g. slide, aliquot, etc.).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SpecimenContainerType" } ], "strength": "example", "description": "Type of specimen container", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/specimen-container-type" } }, "mapping": [ { "identity": "v2", "map": "SPM-27" }, { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.container.capacity", "resource": { "resourceType": "DataElement", "id": "Specimen.container.capacity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.container.capacity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.container.capacity", "path": "Specimen.container.capacity", "short": "Container volume or size", "definition": "The capacity (volume or other measure) the container may contain.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mapping": [ { "identity": "v2", "map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20" }, { "identity": "rim", "map": ".quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.container.specimenQuantity", "resource": { "resourceType": "DataElement", "id": "Specimen.container.specimenQuantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.container.specimenQuantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.container.specimenQuantity", "path": "Specimen.container.specimenQuantity", "short": "Quantity of specimen within container", "definition": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mapping": [ { "identity": "v2", "map": "SAC-23 (value) SAC-24 (units" }, { "identity": "rim", "map": ".playedRole[classCode=CONT].quantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.container.additiveX", "resource": { "resourceType": "DataElement", "id": "Specimen.container.additiveX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.container.additiveX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.container.additive[x]", "path": "Specimen.container.additive[x]", "short": "Additive associated with container", "definition": "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SpecimenContainerAdditive" } ], "strength": "example", "description": "Substance added to specimen container", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0371" } }, "mapping": [ { "identity": "v2", "map": "SAC-27" }, { "identity": "rim", "map": ".scopesRole[classCode=ADTV].player" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Specimen.note", "resource": { "resourceType": "DataElement", "id": "Specimen.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Specimen.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Specimen.note", "path": "Specimen.note", "short": "Comments", "definition": "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance", "path": "AllergyIntolerance", "short": "Allergy or Intolerance (generally: Risk of adverse reaction to a substance)", "definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.", "comment": "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.", "alias": [ "Allergy", "Intolerance", "Adverse Reaction" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "ait-1", "severity": "error", "human": "AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.", "expression": "verificationStatus='entered-in-error' or clinicalStatus.exists()", "xpath": "f:verificationStatus/@value='entered-in-error' or exists(f:clinicalStatus)" }, { "key": "ait-2", "severity": "error", "human": "AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error", "expression": "verificationStatus!='entered-in-error' or clinicalStatus.empty()", "xpath": "f:verificationStatus/@value!='entered-in-error' or not(exists(f:clinicalStatus))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.identifier", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.identifier", "path": "AllergyIntolerance.identifier", "short": "External ids for this item", "definition": "This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "IAM-7" }, { "identity": "rim", "map": "id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.clinicalStatus", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.clinicalStatus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.clinicalStatus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.clinicalStatus", "path": "AllergyIntolerance.clinicalStatus", "short": "active | inactive | resolved", "definition": "The clinical status of the allergy or intolerance.", "comment": "This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as not currently valid.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "condition": [ "ait-1", "ait-2" ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceClinicalStatus" } ], "strength": "required", "description": "The clinical status of the allergy or intolerance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/allergy-clinical-status" } }, "mapping": [ { "identity": "rim", "map": "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.verificationStatus", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.verificationStatus", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.verificationStatus", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.verificationStatus", "path": "AllergyIntolerance.verificationStatus", "short": "unconfirmed | confirmed | refuted | entered-in-error", "definition": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).", "comment": "This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "condition": [ "ait-1", "ait-2" ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceVerificationStatus" } ], "strength": "required", "description": "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/allergy-verification-status" } }, "mapping": [ { "identity": "rim", "map": "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.type", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.type", "path": "AllergyIntolerance.type", "short": "allergy | intolerance - Underlying mechanism (if known)", "definition": "Identification of the underlying physiological mechanism for the reaction risk.", "comment": "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. Often the term \"allergy\" is used rather generically and may overlap with the use of \"intolerance\" - in practice the boundaries between these two concepts may not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.", "alias": [ "Category", "Class" ], "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceType" } ], "strength": "required", "description": "Identification of the underlying physiological mechanism for a Reaction Risk.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type" } }, "mapping": [ { "identity": "v2", "map": "IAM-9" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.category", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.category", "path": "AllergyIntolerance.category", "short": "food | medication | environment | biologic", "definition": "Category of the identified substance.", "comment": "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.", "alias": [ "Category", "Type", "Reaction Type", "Class" ], "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceCategory" } ], "strength": "required", "description": "Category of an identified substance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-category" } }, "mapping": [ { "identity": "v2", "map": "AL1-2" }, { "identity": "rim", "map": "value < IntoleranceValue (Agent)" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.criticality", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.criticality", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.criticality", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.criticality", "path": "AllergyIntolerance.criticality", "short": "low | high | unable-to-assess", "definition": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.", "comment": "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).\n\nSystems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term \"severity\" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.", "alias": [ "Severity", "Seriousness", "Contra-indication", "Risk" ], "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceCriticality" } ], "strength": "required", "description": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality" } }, "mapping": [ { "identity": "v2", "map": "AL1-4" }, { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" }, { "identity": "w5", "map": "grade" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.code", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.code", "path": "AllergyIntolerance.code", "short": "Code that identifies the allergy or intolerance", "definition": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\") or a general or categorical negated statement (e.g., \"No known allergy\", \"No known drug allergies\").", "comment": "It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.\r\rWhen a substance or product code is specified for the 'code' element, the \"default\" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the \"Causative agent\" relationship.\r\rThe 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make \"no known allergy\" (or \"no risk of adverse reaction\") statements regarding any coded substance/product (including cases when a pre-coordinated \"no allergy to x\" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.", "alias": [ "Code" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceCode" } ], "strength": "example", "description": "Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/allergyintolerance-code" } }, "mapping": [ { "identity": "v2", "map": "AL1-3 / IAM-3" }, { "identity": "rim", "map": "substance/product:\r\r.participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\r\rnegated/excluded substance/product:\r\r.participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\r\rpositive or negated/excluded condition/situation:\r\rObservation.code=ASSERTION; Observation.value" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.patient", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.patient", "path": "AllergyIntolerance.patient", "short": "Who the sensitivity is for", "definition": "The patient who has the allergy or intolerance.", "alias": [ "Patient" ], "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(PID-3)" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role[classCode=PAT]" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.onsetX", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.onsetX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.onsetX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.onset[x]", "path": "AllergyIntolerance.onset[x]", "short": "When allergy or intolerance was identified", "definition": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Range" }, { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "effectiveTime.low" }, { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.assertedDate", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.assertedDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.assertedDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.assertedDate", "path": "AllergyIntolerance.assertedDate", "short": "Date record was believed accurate", "definition": "The date on which the existance of the AllergyIntolerance was first asserted or acknowledged.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "v2", "map": "IAM-20" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.recorder", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.recorder", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.recorder", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.recorder", "path": "AllergyIntolerance.recorder", "short": "Who recorded the sensitivity", "definition": "Individual who recorded the record and takes responsibility for its content.", "alias": [ "Author" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.asserter", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.asserter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.asserter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.asserter", "path": "AllergyIntolerance.asserter", "short": "Source of the information about the allergy", "definition": "The source of the information about the allergy that is recorded.", "comment": "The recorder takes repsonsibility for the content, but can reference the source from where they got it.", "alias": [ "Source", "Informant" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "IAM-14 (if patient) / IAM-18 (if practitioner)" }, { "identity": "rim", "map": ".participation[typeCode=INF].role" }, { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.lastOccurrence", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.lastOccurrence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.lastOccurrence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.lastOccurrence", "path": "AllergyIntolerance.lastOccurrence", "short": "Date(/time) of last known occurrence of a reaction", "definition": "Represents the date and/or time of the last known occurrence of a reaction event.", "comment": "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "rim", "map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.note", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.note", "path": "AllergyIntolerance.note", "short": "Additional text not captured in other fields", "definition": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.", "comment": "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction", "path": "AllergyIntolerance.reaction", "short": "Adverse Reaction Events linked to exposure to substance", "definition": "Details about each adverse reaction event linked to exposure to the identified substance.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.substance", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction.substance", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.substance", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction.substance", "path": "AllergyIntolerance.reaction.substance", "short": "Specific substance or pharmaceutical product considered to be responsible for event", "definition": "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'.", "comment": "Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, \"penicillins\"), the 'reaction.substance' element could be used to code the specific substance that was identifed as having caused the reaction (for example, \"amoxycillin\"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubstanceCode" } ], "strength": "example", "description": "Codes defining the type of the substance (including pharmaceutical products).", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/substance-code" } }, "mapping": [ { "identity": "rim", "map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.manifestation", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction.manifestation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.manifestation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction.manifestation", "path": "AllergyIntolerance.reaction.manifestation", "short": "Clinical symptoms/signs associated with the Event", "definition": "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.", "comment": "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.", "alias": [ "Symptoms", "Signs" ], "min": 1, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Manifestation" } ], "strength": "example", "description": "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } }, "mapping": [ { "identity": "v2", "map": "AL1-5" }, { "identity": "rim", "map": "code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.description", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction.description", "path": "AllergyIntolerance.reaction.description", "short": "Description of the event as a whole", "definition": "Text description about the reaction as a whole, including details of the manifestation if required.", "comment": "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.", "alias": [ "Narrative", "Text" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.onset", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction.onset", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.onset", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction.onset", "path": "AllergyIntolerance.reaction.onset", "short": "Date(/time) when manifestations showed", "definition": "Record of the date and/or time of the onset of the Reaction.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "v2", "map": "AL1-6" }, { "identity": "rim", "map": "effectiveTime.low" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.severity", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction.severity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.severity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction.severity", "path": "AllergyIntolerance.reaction.severity", "short": "mild | moderate | severe (of event as a whole)", "definition": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.", "comment": "It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AllergyIntoleranceSeverity" } ], "strength": "required", "description": "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/reaction-event-severity" } }, "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.exposureRoute", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction.exposureRoute", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.exposureRoute", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction.exposureRoute", "path": "AllergyIntolerance.reaction.exposureRoute", "short": "How the subject was exposed to the substance", "definition": "Identification of the route by which the subject was exposed to the substance.", "comment": "Coding of the route of exposure with a terminology should be used wherever possible.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RouteOfAdministration" } ], "strength": "example", "description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/route-codes" } }, "mapping": [ { "identity": "rim", "map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.note", "resource": { "resourceType": "DataElement", "id": "AllergyIntolerance.reaction.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/AllergyIntolerance.reaction.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "AllergyIntolerance.reaction.note", "path": "AllergyIntolerance.reaction.note", "short": "Text about event not captured in other fields", "definition": "Additional text about the adverse reaction event not captured in other fields.", "comment": "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan", "resource": { "resourceType": "DataElement", "id": "CarePlan", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan", "status": "draft", "experimental": true, "stringency": "fully-specified", "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": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.identifier", "resource": { "resourceType": "DataElement", "id": "CarePlan.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.identifier", "path": "CarePlan.identifier", "short": "External Ids for this plan", "definition": "This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "requirements": "Need to allow connection to a wider workflow.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "v2", "map": "PTH-3" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.definition", "resource": { "resourceType": "DataElement", "id": "CarePlan.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.definition", "path": "CarePlan.definition", "short": "Protocol or definition", "definition": "Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.definition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.basedOn", "resource": { "resourceType": "DataElement", "id": "CarePlan.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.basedOn", "path": "CarePlan.basedOn", "short": "Fulfills care plan", "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": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.basedOn" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.replaces", "resource": { "resourceType": "DataElement", "id": "CarePlan.replaces", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.replaces", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.replaces" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.partOf", "resource": { "resourceType": "DataElement", "id": "CarePlan.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.status", "resource": { "resourceType": "DataElement", "id": "CarePlan.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.status", "path": "CarePlan.status", "short": "draft | active | suspended | completed | entered-in-error | cancelled | 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" } ], "isModifier": true, "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-plan-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status (uses different ValueSet)" }, { "identity": "v2", "map": "PTH-5" }, { "identity": "rim", "map": ".statusCode planned = new active = active completed = completed" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.intent", "resource": { "resourceType": "DataElement", "id": "CarePlan.intent", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.intent", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.intent", "path": "CarePlan.intent", "short": "proposal | plan | order | option", "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.", "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" } ], "isModifier": true, "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-plan-intent" } }, "mapping": [ { "identity": "workflow", "map": "Request.intent" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.category", "resource": { "resourceType": "DataElement", "id": "CarePlan.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 axis 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" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-plan-category" } }, "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.title", "resource": { "resourceType": "DataElement", "id": "CarePlan.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.title", "path": "CarePlan.title", "short": "Human-friendly name for the CarePlan", "definition": "Human-friendly name for the CarePlan.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.description", "resource": { "resourceType": "DataElement", "id": "CarePlan.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.subject", "resource": { "resourceType": "DataElement", "id": "CarePlan.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.subject", "path": "CarePlan.subject", "short": "Who 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" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".participation[typeCode=PAT].role[classCode=PAT]" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.context", "resource": { "resourceType": "DataElement", "id": "CarePlan.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.context", "path": "CarePlan.context", "short": "Created in context of", "definition": "Identifies the original context in which this particular CarePlan was created.", "comment": "Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.", "alias": [ "encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.context" }, { "identity": "v2", "map": "Associated PV1" }, { "identity": "rim", "map": "." }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.period", "resource": { "resourceType": "DataElement", "id": "CarePlan.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.occurrencePeriod" }, { "identity": "v2", "map": "GOL-7 / GOL-8" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.author", "resource": { "resourceType": "DataElement", "id": "CarePlan.author", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.author", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.author", "path": "CarePlan.author", "short": "Who is responsible for contents of the plan", "definition": "Identifies the individual(s) or ogranization who is responsible for the content of the care plan.", "comment": "Collaborative care plans may have multiple authors.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester.agent (if only one author)" }, { "identity": "w5", "map": "who.source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.careTeam", "resource": { "resourceType": "DataElement", "id": "CarePlan.careTeam", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.careTeam", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "workflow", "map": "Request.performer (similar but does not entail CareTeam)" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.addresses", "resource": { "resourceType": "DataElement", "id": "CarePlan.addresses", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.addresses", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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.", "requirements": "Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like \"at risk for hypertension\" or \"fall risk\".) Also scopes plans - multiple plans may exist addressing different concerns.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.reasonReference" }, { "identity": "v2", "map": "PRB-4" }, { "identity": "rim", "map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.supportingInfo", "resource": { "resourceType": "DataElement", "id": "CarePlan.supportingInfo", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.supportingInfo", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 co-morbidities, recent procedures, limitations, recent assessments, etc.", "comment": "Use \"concern\" to identify specific conditions addressed by the care plan.", "requirements": "Identifies barriers and other considerations associated with the care plan.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.goal", "resource": { "resourceType": "DataElement", "id": "CarePlan.goal", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.goal", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "v2", "map": "GOL.1" }, { "identity": "rim", "map": ".outboundRelationship[typeCode<=OBJ]." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity", "path": "CarePlan.activity", "short": "Action to occur as part of plan", "definition": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, 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": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "cpl-3", "severity": "error", "human": "Provide a reference or detail, not both", "expression": "detail.empty() or reference.empty()", "xpath": "not(exists(f:detail)) or not(exists(f:reference))" } ], "mapping": [ { "identity": "workflow", "map": "no mapping\nNOTE: This is a list of contained Request-Event tuples!" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.outcomeCodeableConcept", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.outcomeCodeableConcept", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.outcomeCodeableConcept", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.outcomeCodeableConcept", "path": "CarePlan.activity.outcomeCodeableConcept", "short": "Results of the activity", "definition": "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).", "comment": "Note that this should not duplicate the activity status (e.g. completed or in progress).", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CarePlanActivityOutcome" } ], "strength": "example", "description": "Identifies the results of the activity", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-outcome" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.outcomeReference", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.outcomeReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.outcomeReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.outcomeReference", "path": "CarePlan.activity.outcomeReference", "short": "Appointment, Encounter, Procedure, etc.", "definition": "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).", "comment": "The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lb and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.", "requirements": "Links plan to resulting actions.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Event that is outcome of Request in activity.reference" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=FLFS].source" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.progress", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.progress", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.progress", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "workflow", "map": "Event.status (Annotation instead of CodableConcept)" }, { "identity": "v2", "map": "NTE?" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.reference", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.reference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.reference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.reference", "path": "CarePlan.activity.reference", "short": "Activity details defined in specific resource", "definition": "The details of the proposed activity represented in a specific resource.", "comment": "Standard extension exists ([goal-pertainstogoal](extension-goal-pertainstogoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. \rThe goal should be visible when the resource referenced by CarePlan.activity.reference is viewed indepedently 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" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DeviceRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Task" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RequestGroup" } ], "condition": [ "cpl-3" ], "mapping": [ { "identity": "workflow", "map": "Request that resulted in Event in activity.actionResulting" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail", "path": "CarePlan.activity.detail", "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" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.category", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.category", "path": "CarePlan.activity.detail.category", "short": "diet | drug | encounter | observation | procedure | supply | other", "definition": "High-level categorization of the type of activity in a care plan.", "requirements": "May determine what types of extensions are permitted.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CarePlanActivityCategory" } ], "strength": "example", "description": "High-level categorization of the type of activity in a care plan.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-category" } }, "mapping": [ { "identity": "workflow", "map": "Request.supportingInformation" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.definition", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.definition", "path": "CarePlan.activity.detail.definition", "short": "Protocol or definition", "definition": "Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.", "requirements": "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire" } ], "mapping": [ { "identity": "workflow", "map": "Request.definition" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.code", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.code", "path": "CarePlan.activity.detail.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" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-plan-activity" } }, "mapping": [ { "identity": "workflow", "map": "Request.code" }, { "identity": "v2", "map": "OBR-4 / RXE-2 / RXO-1 / RXD-2" }, { "identity": "rim", "map": ".code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.reasonCode", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.reasonCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.reasonCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.reasonCode", "path": "CarePlan.activity.detail.reasonCode", "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.", "comment": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/activity-reason" } }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.reasonReference", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.reasonReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.reasonReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.reasonReference", "path": "CarePlan.activity.detail.reasonReference", "short": "Condition triggering need for activity", "definition": "Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.", "comment": "Conditions can be identified at the activity level that are not identified as reasons for the overall plan.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" } ], "mapping": [ { "identity": "workflow", "map": "Request.reasonReference" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.goal", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.goal", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.goal", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.goal", "path": "CarePlan.activity.detail.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" } ], "mapping": [ { "identity": "workflow", "map": "Request.goal" }, { "identity": "rim", "map": ".outboundRelationship[typeCode<=OBJ]." } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.status", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.status", "path": "CarePlan.activity.detail.status", "short": "not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown", "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" } ], "isModifier": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CarePlanActivityStatus" } ], "strength": "required", "description": "Indicates where the activity is at in its overall life cycle.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status (uses different ValueSet)" }, { "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.statusReason", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.statusReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.statusReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.statusReason", "path": "CarePlan.activity.detail.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": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.prohibited", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.prohibited", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.prohibited", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.prohibited", "path": "CarePlan.activity.detail.prohibited", "short": "Do NOT do", "definition": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, 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" } ], "defaultValueBoolean": false, "isModifier": true, "mapping": [ { "identity": "rim", "map": "actionNegationInd" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.scheduledX", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.scheduledX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.scheduledX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.scheduled[x]", "path": "CarePlan.activity.detail.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" } ], "mapping": [ { "identity": "workflow", "map": "Request.occurrence" }, { "identity": "v2", "map": "TQ1" }, { "identity": "rim", "map": ".effectiveTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.location", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.location", "path": "CarePlan.activity.detail.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": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "mapping": [ { "identity": "v2", "map": "OBR-24(???!!)" }, { "identity": "rim", "map": ".participation[typeCode=LOC].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.performer", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.performer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.performer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.performer", "path": "CarePlan.activity.detail.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" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" } ], "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "v2", "map": "PRT-5 : ( PRV-4 e {provider participations} ) / PRT-5 : ( PRV-4 e {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8" }, { "identity": "rim", "map": ".participation[typeCode=PFM]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.productX", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.productX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.productX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.product[x]", "path": "CarePlan.activity.detail.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" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-codes" } }, "mapping": [ { "identity": "v2", "map": "RXE-2 / RXO-1 / RXD-2" }, { "identity": "rim", "map": ".participation[typeCode=PRD].role" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.dailyAmount", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.dailyAmount", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.dailyAmount", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.dailyAmount", "path": "CarePlan.activity.detail.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" } ], "mapping": [ { "identity": "v2", "map": "RXO-23 / RXE-19 / RXD-12" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.quantity", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.quantity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.quantity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.quantity", "path": "CarePlan.activity.detail.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" } ], "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.description", "resource": { "resourceType": "DataElement", "id": "CarePlan.activity.detail.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.activity.detail.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "CarePlan.activity.detail.description", "path": "CarePlan.activity.detail.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" } ], "mapping": [ { "identity": "workflow", "map": "Request.note" }, { "identity": "v2", "map": "NTE?" }, { "identity": "rim", "map": ".text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/CarePlan.note", "resource": { "resourceType": "DataElement", "id": "CarePlan.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/CarePlan.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "workflow", "map": "Request.note" }, { "identity": "v2", "map": "NTE?" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition", "resource": { "resourceType": "DataElement", "id": "StructureDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "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": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "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 the an element without a \".\" in the path (e.g. the first element)", "expression": "children().element.first().label.empty() and children().element.first().code.empty() and children().element.first().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)]))" }, { "key": "sdf-19", "requirements": "custom types only in logical models", "severity": "error", "human": "Custom types can only be used in logical models", "expression": "kind = 'logical' or (differential.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')) and snapshot.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')))", "xpath": "f:kind/@value = 'logical' 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" }, { "key": "sdf-16", "requirements": "element ids need to be unique", "severity": "error", "human": "All element definitions must have unique ids (snapshot)", "expression": "snapshot.element.id.trace('ids').isDistinct()", "xpath": "count(*/f:element)=count(*/f:element/@id)" }, { "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')" }, { "key": "sdf-17", "requirements": "element ids need to be unique", "severity": "error", "human": "All element definitions must have unique ids (diff)", "expression": "differential.element.id.trace('ids').isDistinct()", "xpath": "count(*/f:element)=count(*/f:element/@id)" }, { "key": "sdf-12", "requirements": "Ensure that element.base appears with base or not", "severity": "error", "human": "element.base cannot appear if there is no base on the structure definition", "expression": "snapshot.exists() implies (snapshot.element.base.exists() = baseDefinition.exists())", "xpath": "f:baseDefinition or not(exists(f:snapshot/f:element/f:base) or exists(f:differential/f:element/f:base))" }, { "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": "snapshot.empty() or snapshot.element.first().path = type", "xpath": "not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)" }, { "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)" }, { "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)))" }, { "key": "sdf-7", "severity": "error", "human": "If the structure describes a base Resource or Type, the URL has to start with \"http://hl7.org/fhir/StructureDefinition/\" and the tail must match the id", "expression": "(derivation = 'constraint') or (kind = 'logical') or (url = 'http://hl7.org/fhir/StructureDefinition/'+id)", "xpath": "(f:derivation/@value = 'constraint') or (f:kind/@value = 'logical') or (f:url/@value=concat('http://hl7.org/fhir/StructureDefinition/', f:id/@value))" }, { "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)" }, { "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() and contextType.exists())", "xpath": "not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context) and exists(f:contextType))" }, { "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)" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "conformance.content" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.url", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.url", "path": "StructureDefinition.url", "short": "Logical URI to reference this structure definition (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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "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" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.identifier", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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, e.g., to 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" } ], "isSummary": true, "mapping": [ { "identity": "iso11179", "map": "Identifier part" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.version", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 refrence to a particular business version of the structure definition with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "iso11179", "map": "Version" }, { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.name", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.title", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.status", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired structure definition without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "iso11179", "map": "Registration status" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.experimental", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental structure definition in production.", "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" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "iso11179", "map": "Registration status" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.date", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.date", "path": "StructureDefinition.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the structure definition was published. The date must change if and 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" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.publisher", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.publisher", "path": "StructureDefinition.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization 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" } ], "isSummary": true, "mapping": [ { "identity": "iso11179", "map": "Registration Authority" }, { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.contact", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.description", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.useContext", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.useContext", "path": "StructureDefinition.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure definition instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.jurisdiction", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.purpose", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.purpose", "path": "StructureDefinition.purpose", "short": "Why this structure definition is defined", "definition": "Explaination 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" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.copyright", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.keyword", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.keyword", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.keyword", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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.", "requirements": "Assist in searching for appropriate StructureDefinitions.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "StructureDefinitionCode" } ], "strength": "example", "description": "Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/profile-code" } }, "mapping": [ { "identity": "iso11179", "map": "keywords" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.fhirVersion", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.fhirVersion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.fhirVersion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 3.0.1 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": "id" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.mapping", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "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)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.identity", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.mapping.identity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.identity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.uri", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.mapping.uri", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.uri", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.name", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.mapping.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.comment", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.mapping.comment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.mapping.comment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.kind", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.kind", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.kind", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/structure-definition-kind" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.abstract", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.abstract", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.abstract", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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 profile, but have children described, are anonymous concrete types that specialise Element.", "min": 1, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.contextType", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.contextType", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.contextType", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.contextType", "path": "StructureDefinition.contextType", "short": "resource | datatype | extension", "definition": "If this is an extension, Identifies the context within FHIR resources where the extension can be used.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "condition": [ "sdf-5" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ExtensionContext" } ], "strength": "required", "description": "How an extension context is interpreted.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/extension-context" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.context", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.context", "path": "StructureDefinition.context", "short": "Where the extension can be used in instances", "definition": "Identifies the types of resource or data type elements to which the extension can be applied.", "comment": "If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of \"string\" doesn't mean that the extension can be used with one of the string patterns such as \"id\" etc.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "condition": [ "sdf-5" ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.contextInvariant", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.contextInvariant", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.contextInvariant", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.contextInvariant", "path": "StructureDefinition.contextInvariant", "short": "FHIRPath invariants - when the extension can be used", "definition": "A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).", "comment": "All the rules must be true. When evaluating the invariant, the fluentpath focus is the element that holds the extension, and %extension refers to the extension itself.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "condition": [ "sdf-18" ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.type", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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).", "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.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "condition": [ "sdf-4", "sdf-11" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRDefinedTypeExt" } ], "strength": "extensible", "description": "Either a resource or a data type, including logical model types", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/defined-types" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.baseDefinition", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.baseDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.baseDefinition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": [ { "code": "uri" } ], "condition": [ "sdf-4" ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.derivation", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.derivation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.derivation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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.\n\nIf the definition is a constraint, then it can not 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-12" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TypeDerivationRule" } ], "strength": "required", "description": "How a type relates to its baseDefinition.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/type-derivation-rule" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.snapshot", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.snapshot", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.snapshot", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "StructureDefinition.snapshot", "path": "StructureDefinition.snapshot", "short": "Snapshot view of the structure", "definition": "A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.", "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() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "sdf-15", "requirements": "No Type on the root element (snapshot)", "severity": "error", "human": "The first element in a snapshot has no type", "expression": "element.first().type.empty()", "xpath": "not(f:element[1]/f:type)" }, { "key": "sdf-8", "severity": "error", "human": "In any snapshot, all the elements must be in the specified type", "expression": "element.first().path = %resource.type and element.tail().all(path.startsWith(%resource.type&'.'))", "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, '.'))])" }, { "key": "sdf-3", "severity": "error", "human": "Each element definition in a snapshot must have a formal definition and cardinalities", "expression": "element.all(definition and min and max)", "xpath": "count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.snapshot.element", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.snapshot.element", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.snapshot.element", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" ], "mapping": [ { "identity": "iso11179", "map": "--" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.differential", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.differential", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.differential", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "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, it has no type", "expression": "element.first().path.contains('.').not() implies element.first().type.empty()", "xpath": "not(f:element[1][not(contains(f:path/@value, '.'))]/f:type)" }, { "key": "sdf-20", "requirements": "no slicing on root", "severity": "error", "human": "No slicing on the root element", "expression": "element.first().slicing.empty()", "xpath": "not(f:element[1]/f:slicing)" }, { "key": "sdf-8a", "severity": "error", "human": "In any differential, all the elements must be in the specified type", "expression": "element.first().path.startsWith(%resource.type) and element.tail().all(path.startsWith(%resource.type&'.'))", "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, '.'))])" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/StructureDefinition.differential.element", "resource": { "resourceType": "DataElement", "id": "StructureDefinition.differential.element", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/StructureDefinition.differential.element", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "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" } ], "mapping": [ { "identity": "iso11179", "map": "--" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare", "path": "EpisodeOfCare", "short": "An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility", "definition": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.", "alias": [ "Case Program Problem" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "workflow.encounter" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.identifier", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.identifier", "path": "EpisodeOfCare.identifier", "short": "Business Identifier(s) relevant for this EpisodeOfCare", "definition": "The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.status", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.status", "path": "EpisodeOfCare.status", "short": "planned | waitlist | active | onhold | finished | cancelled | entered-in-error", "definition": "planned | waitlist | active | onhold | finished | cancelled.", "comment": "This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EpisodeOfCareStatus" } ], "strength": "required", "description": "The status of the episode of care.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/episode-of-care-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.statusHistory", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.statusHistory", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.statusHistory", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.statusHistory", "path": "EpisodeOfCare.statusHistory", "short": "Past list of status codes (the current status may be included to cover the start date of the status)", "definition": "The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.statusHistory.status", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.statusHistory.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.statusHistory.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.statusHistory.status", "path": "EpisodeOfCare.statusHistory.status", "short": "planned | waitlist | active | onhold | finished | cancelled | entered-in-error", "definition": "planned | waitlist | active | onhold | finished | cancelled.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EpisodeOfCareStatus" } ], "strength": "required", "description": "The status of the episode of care.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/episode-of-care-status" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.statusHistory.period", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.statusHistory.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.statusHistory.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.statusHistory.period", "path": "EpisodeOfCare.statusHistory.period", "short": "Duration the EpisodeOfCare was in the specified status", "definition": "The period during this EpisodeOfCare that the specific status applied.", "min": 1, "max": "1", "type": [ { "code": "Period" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.type", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.type", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.type", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.type", "path": "EpisodeOfCare.type", "short": "Type/class - e.g. specialist referral, disease management", "definition": "A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.", "comment": "The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EpisodeOfCareType" } ], "strength": "example", "description": "The type of the episode of care", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/episodeofcare-type" } }, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.diagnosis", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.diagnosis", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Diagnosis" } ], "path": "EpisodeOfCare.diagnosis", "short": "The list of diagnosis relevant to this episode of care", "definition": "The list of diagnosis relevant to this episode of care.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis.condition", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.diagnosis.condition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis.condition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.diagnosis.condition", "path": "EpisodeOfCare.diagnosis.condition", "short": "Conditions/problems/diagnoses this episode of care is for", "definition": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis.role", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.diagnosis.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.diagnosis.role", "path": "EpisodeOfCare.diagnosis.role", "short": "Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)", "definition": "Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosisRole" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "The type of diagnosis this condition represents", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/diagnosis-role" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis.rank", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.diagnosis.rank", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.diagnosis.rank", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.diagnosis.rank", "path": "EpisodeOfCare.diagnosis.rank", "short": "Ranking of the diagnosis (for each role type)", "definition": "Ranking of the diagnosis (for each role type).", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.patient", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.patient", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.patient", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.patient", "path": "EpisodeOfCare.patient", "short": "The patient who is the focus of this episode of care", "definition": "The patient who is the focus of this episode of care.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.managingOrganization", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.managingOrganization", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.managingOrganization", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.managingOrganization", "path": "EpisodeOfCare.managingOrganization", "short": "Organization that assumes care", "definition": "The organization that has assumed the specific responsibilities for the specified duration.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.period", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.period", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.period", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.period", "path": "EpisodeOfCare.period", "short": "Interval during responsibility is assumed", "definition": "The interval during which the managing organization assumes the defined responsibility.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.referralRequest", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.referralRequest", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.referralRequest", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.referralRequest", "path": "EpisodeOfCare.referralRequest", "short": "Originating Referral Request(s)", "definition": "Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.careManager", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.careManager", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.careManager", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.careManager", "path": "EpisodeOfCare.careManager", "short": "Care manager/care co-ordinator for the patient", "definition": "The practitioner that is the care manager/care co-ordinator for this patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.team", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.team", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.team", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.team", "path": "EpisodeOfCare.team", "short": "Other practitioners facilitating this episode of care", "definition": "The list of practitioners that may be facilitating this episode of care for specific purposes.", "alias": [ "CareTeam" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/EpisodeOfCare.account", "resource": { "resourceType": "DataElement", "id": "EpisodeOfCare.account", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/EpisodeOfCare.account", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "EpisodeOfCare.account", "path": "EpisodeOfCare.account", "short": "The set of accounts that may be used for billing for this EpisodeOfCare", "definition": "The set of accounts that may be used for billing for this EpisodeOfCare.", "comment": "The billing system may choose to allocate billable items associated with the EpisodeOfCare to different referenced Accounts based on internal business rules.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Account" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome", "resource": { "resourceType": "DataElement", "id": "OperationOutcome", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome", "path": "OperationOutcome", "short": "Information about the success/failure of an action", "definition": "A collection of error, warning or information messages that result from a system action.", "comment": "Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)" }, { "identity": "w5", "map": "infrastructure.exchange" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome.issue", "resource": { "resourceType": "DataElement", "id": "OperationOutcome.issue", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome.issue", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome.issue", "path": "OperationOutcome.issue", "short": "A single issue associated with the action", "definition": "An error, warning or information message that results from a system action.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ERR" }, { "identity": "rim", "map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.severity", "resource": { "resourceType": "DataElement", "id": "OperationOutcome.issue.severity", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.severity", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome.issue.severity", "path": "OperationOutcome.issue.severity", "short": "fatal | error | warning | information", "definition": "Indicates whether the issue indicates a variation from successful processing.", "comment": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.", "requirements": "Indicates how relevant the issue is to the overall success of the action.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IssueSeverity" } ], "strength": "required", "description": "How the issue affects the success of the action.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/issue-severity" } }, "mapping": [ { "identity": "v2", "map": "ERR-4" }, { "identity": "rim", "map": "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.code", "resource": { "resourceType": "DataElement", "id": "OperationOutcome.issue.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome.issue.code", "path": "OperationOutcome.issue.code", "short": "Error or warning code", "definition": "Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.", "requirements": "Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IssueType" } ], "strength": "required", "description": "A code that describes the type of issue.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/issue-type" } }, "mapping": [ { "identity": "v2", "map": "ERR-3" }, { "identity": "rim", "map": "./code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.details", "resource": { "resourceType": "DataElement", "id": "OperationOutcome.issue.details", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.details", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome.issue.details", "path": "OperationOutcome.issue.details", "short": "Additional details about the error", "definition": "Additional details about the error. This may be a text description of the error, or a system code that identifies the error.", "comment": "A human readable description of the error issue SHOULD be placed in details.text.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IssueDetails" } ], "strength": "example", "description": "A code that provides details as the exact issue.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/operation-outcome" } }, "mapping": [ { "identity": "v2", "map": "ERR-5" }, { "identity": "rim", "map": "./code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.diagnostics", "resource": { "resourceType": "DataElement", "id": "OperationOutcome.issue.diagnostics", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.diagnostics", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome.issue.diagnostics", "path": "OperationOutcome.issue.diagnostics", "short": "Additional diagnostic information about the issue", "definition": "Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.", "comment": "Typically this field is used to provide troubleshooting information about the error.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ERR-8" }, { "identity": "rim", "map": "./text[parent::AcknowledgmentDetail]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.location", "resource": { "resourceType": "DataElement", "id": "OperationOutcome.issue.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome.issue.location", "path": "OperationOutcome.issue.location", "short": "Path of element(s) related to issue", "definition": "For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name.", "comment": "The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON. Note that expression is being trialed as an alternative to XPath.", "requirements": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ERR-2" }, { "identity": "rim", "map": "./location[parent::AcknowledgmentDetail]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.expression", "resource": { "resourceType": "DataElement", "id": "OperationOutcome.issue.expression", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/OperationOutcome.issue.expression", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "OperationOutcome.issue.expression", "path": "OperationOutcome.issue.expression", "short": "FHIRPath of element(s) related to issue", "definition": "A simple FHIRPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.", "comment": "The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.", "requirements": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ERR-2" }, { "identity": "rim", "map": "./location[parent::AcknowledgmentDetail]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure", "resource": { "resourceType": "DataElement", "id": "Procedure", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure", "path": "Procedure", "short": "An action that is being or was performed on a patient", "definition": "An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "pro-1", "severity": "error", "human": "Reason not done is only permitted if notDone indicator is true", "expression": "notDoneReason.empty() or notDone = true", "xpath": "not(exists(f:notDoneReason)) or f:notDone/@value=true()" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Procedure[moodCode=EVN]" }, { "identity": "w5", "map": "clinical.general" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.identifier", "resource": { "resourceType": "DataElement", "id": "Procedure.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.identifier", "path": "Procedure.identifier", "short": "External Identifiers for this procedure", "definition": "This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "requirements": "Need to allow connection to a wider workflow.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Some combination of ORC-2 / ORC-3 / OBR-2 / OBR-3 / IPC-1 / IPC-2 / IPC-3 / IPC-4" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.definition", "resource": { "resourceType": "DataElement", "id": "Procedure.definition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.definition", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.definition", "path": "Procedure.definition", "short": "Instantiates protocol or definition", "definition": "A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.basedOn", "resource": { "resourceType": "DataElement", "id": "Procedure.basedOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.basedOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.basedOn", "path": "Procedure.basedOn", "short": "A request for this procedure", "definition": "A reference to a resource that contains details of the request for this procedure.", "alias": [ "fulfills" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[classCode=(various e.g. PROC, OBS, PCPR, ACT, moodCode=RQO].code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.partOf", "resource": { "resourceType": "DataElement", "id": "Procedure.partOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.partOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.partOf", "path": "Procedure.partOf", "short": "Part of referenced event", "definition": "A larger event of which this particular procedure is a component or step.", "comment": "The MedicationAdministration has a partOf reference to Procedure, but this is not a circular reference. For a surgical procedure, the anesthesia related medicationAdministration is part of the procedure. For an IV medication administration, the procedure to insert the IV port is part of the medication administration.", "alias": [ "container" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=SBADM or PROC or OBS, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.status", "resource": { "resourceType": "DataElement", "id": "Procedure.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.status", "path": "Procedure.status", "short": "preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown", "definition": "A code specifying the state of the procedure. Generally this will be in-progress or completed state.", "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 procedure.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureStatus" } ], "strength": "required", "description": "A code specifying the state of the procedure.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/event-status" } }, "mapping": [ { "identity": "rim", "map": "statusCode" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.notDone", "resource": { "resourceType": "DataElement", "id": "Procedure.notDone", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.notDone", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.notDone", "path": "Procedure.notDone", "short": "True if procedure was not performed as scheduled", "definition": "Set this to true if the record is saying that the procedure was NOT performed.", "comment": "If true, it means the procedure did not occur as described. Typically it would be accompanied by attributes describing the type of activity. It might also be accompanied by body site information or time information (i.e. no procedure was done to the left arm or no procedure was done in this 2-year period). Specifying additional information such as performer, outcome, etc. is generally inappropriate. For example, it's not that useful to say \"There was no appendectomy done at 12:03pm June 6th by Dr. Smith with a successful outcome\" as it implies that there *could* have been an appendectomy done at any other time, by any other clinician or with any other outcome.\n\nThis element is labeled as a modifier because it indicates that a procedure didn't happen.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".actionNegationInd" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.notDoneReason", "resource": { "resourceType": "DataElement", "id": "Procedure.notDoneReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.notDoneReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.notDoneReason", "path": "Procedure.notDoneReason", "short": "Reason procedure was not performed", "definition": "A code indicating why the procedure was not performed.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "pro-1" ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureNegationReason" } ], "strength": "example", "description": "A code that identifies the reason a procedure was not performed.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason" } }, "mapping": [ { "identity": "rim", "map": ".reason.Observation.value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.category", "resource": { "resourceType": "DataElement", "id": "Procedure.category", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.category", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.category", "path": "Procedure.category", "short": "Classification of the procedure", "definition": "A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureCategory" } ], "strength": "example", "description": "A code that classifies a procedure for searching, sorting and display purposes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-category" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.code", "resource": { "resourceType": "DataElement", "id": "Procedure.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.code", "path": "Procedure.code", "short": "Identification of the procedure", "definition": "The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").", "requirements": "0..1 to account for primarily narrative only resources.", "alias": [ "type" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureCode" } ], "strength": "example", "description": "A code to identify a specific procedure .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-code" } }, "mapping": [ { "identity": "v2", "map": "OBR-44/OBR-45" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.subject", "resource": { "resourceType": "DataElement", "id": "Procedure.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.subject", "path": "Procedure.subject", "short": "Who the procedure was performed on", "definition": "The person, animal or group on which the procedure was performed.", "alias": [ "patient" ], "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.context", "resource": { "resourceType": "DataElement", "id": "Procedure.context", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.context", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.context", "path": "Procedure.context", "short": "Encounter or episode associated with the procedure", "definition": "The encounter during which the procedure was performed.", "alias": [ "encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.performedX", "resource": { "resourceType": "DataElement", "id": "Procedure.performedX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.performedX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.performed[x]", "path": "Procedure.performed[x]", "short": "Date/Period the procedure was performed", "definition": "The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBR-7" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.performer", "resource": { "resourceType": "DataElement", "id": "Procedure.performer", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.performer", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.performer", "path": "Procedure.performer", "short": "The people who performed the procedure", "definition": "Limited to 'real' people rather than equipment.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PRF]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.performer.role", "resource": { "resourceType": "DataElement", "id": "Procedure.performer.role", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.performer.role", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.performer.role", "path": "Procedure.performer.role", "short": "The role the actor was in", "definition": "For example: surgeon, anaethetist, endoscopist.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedurePerformerRole" } ], "strength": "example", "description": "A code that identifies the role of a performer of the procedure.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/performer-role" } }, "mapping": [ { "identity": "v2", "map": "Some combination of STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 / OBX-25" }, { "identity": "rim", "map": ".functionCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.performer.actor", "resource": { "resourceType": "DataElement", "id": "Procedure.performer.actor", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.performer.actor", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.performer.actor", "path": "Procedure.performer.actor", "short": "The reference to the practitioner", "definition": "The practitioner who was involved in the procedure.", "requirements": "A reference to Device supports use cases, such as pacemakers.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-19/PRT-5" }, { "identity": "rim", "map": ".role" }, { "identity": "w5", "map": "who.actor" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.performer.onBehalfOf", "resource": { "resourceType": "DataElement", "id": "Procedure.performer.onBehalfOf", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.performer.onBehalfOf", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.performer.onBehalfOf", "path": "Procedure.performer.onBehalfOf", "short": "Organization the device or practitioner was acting for", "definition": "The organization the device or practitioner was acting on behalf of.", "requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": ".scoper" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.location", "resource": { "resourceType": "DataElement", "id": "Procedure.location", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.location", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.location", "path": "Procedure.location", "short": "Where the procedure happened", "definition": "The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.", "requirements": "Ties a procedure to where the records are likely kept.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=LOC].role[classCode=SDLOC]" }, { "identity": "w5", "map": "where" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.reasonCode", "resource": { "resourceType": "DataElement", "id": "Procedure.reasonCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.reasonCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.reasonCode", "path": "Procedure.reasonCode", "short": "Coded reason procedure performed", "definition": "The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureReason" } ], "strength": "example", "description": "A code that identifies the reason a procedure is required.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-reason" } }, "mapping": [ { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.reasonReference", "resource": { "resourceType": "DataElement", "id": "Procedure.reasonReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.reasonReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.reasonReference", "path": "Procedure.reasonReference", "short": "Condition that is the reason the procedure performed", "definition": "The condition that is the reason why the procedure was performed.", "comment": "e.g. endoscopy for dilatation and biopsy, combination diagnosis and therapeutic.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.bodySite", "resource": { "resourceType": "DataElement", "id": "Procedure.bodySite", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.bodySite", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.bodySite", "path": "Procedure.bodySite", "short": "Target body sites", "definition": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": ".targetSiteCode" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.outcome", "resource": { "resourceType": "DataElement", "id": "Procedure.outcome", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.outcome", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.outcome", "path": "Procedure.outcome", "short": "The result of procedure", "definition": "The outcome of the procedure - did it resolve reasons for the procedure being performed?", "comment": "If outcome contains narrative text only, it can be captured using the CodeableConcept.text.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureOutcome" } ], "strength": "example", "description": "An outcome of a procedure - whether it was resolved or otherwise.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-outcome" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=OUT].target.text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.report", "resource": { "resourceType": "DataElement", "id": "Procedure.report", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.report", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.report", "path": "Procedure.report", "short": "Any report resulting from the procedure", "definition": "This could be a histology result, pathology report, surgical report, etc..", "comment": "There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.complication", "resource": { "resourceType": "DataElement", "id": "Procedure.complication", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.complication", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.complication", "path": "Procedure.complication", "short": "Complication following the procedure", "definition": "Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.", "comment": "If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureComplication" } ], "strength": "example", "description": "Codes describing complications that resulted from a procedure.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/condition-code" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.complicationDetail", "resource": { "resourceType": "DataElement", "id": "Procedure.complicationDetail", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.complicationDetail", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.complicationDetail", "path": "Procedure.complicationDetail", "short": "A condition that is a result of the procedure", "definition": "Any complications that occurred during the procedure, or in the immediate post-performance period.", "requirements": "This is used to document a condition that is a result of the procedure, not the condition that was the reason for the procedure.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.followUp", "resource": { "resourceType": "DataElement", "id": "Procedure.followUp", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.followUp", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.followUp", "path": "Procedure.followUp", "short": "Instructions for follow up", "definition": "If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureFollowUp" } ], "strength": "example", "description": "Specific follow up required for a procedure e.g. removal of sutures.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/procedure-followup" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.note", "resource": { "resourceType": "DataElement", "id": "Procedure.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.note", "path": "Procedure.note", "short": "Additional information about the procedure", "definition": "Any other notes about the procedure. E.g. the operative notes.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "v2", "map": "NTE" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.focalDevice", "resource": { "resourceType": "DataElement", "id": "Procedure.focalDevice", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.focalDevice", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.focalDevice", "path": "Procedure.focalDevice", "short": "Device changed in procedure", "definition": "A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=DEV].role[classCode=MANU]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.focalDevice.action", "resource": { "resourceType": "DataElement", "id": "Procedure.focalDevice.action", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.focalDevice.action", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.focalDevice.action", "path": "Procedure.focalDevice.action", "short": "Kind of change to device", "definition": "The kind of change that happened to the device during the procedure.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceActionKind" } ], "strength": "preferred", "description": "A kind of change that happened to the device during the procedure.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/device-action" } }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"procedure device action\"].value=:procedure device action codes" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.focalDevice.manipulated", "resource": { "resourceType": "DataElement", "id": "Procedure.focalDevice.manipulated", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.focalDevice.manipulated", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.focalDevice.manipulated", "path": "Procedure.focalDevice.manipulated", "short": "Device that was changed", "definition": "The device that was manipulated (changed) during the procedure.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=DEV].role[classCode=SDLOC]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.usedReference", "resource": { "resourceType": "DataElement", "id": "Procedure.usedReference", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.usedReference", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.usedReference", "path": "Procedure.usedReference", "short": "Items used during procedure", "definition": "Identifies medications, devices and any other substance used as part of the procedure.", "comment": "For devices actually implanted or removed, use Procedure.device.", "requirements": "Used for tracking contamination, etc.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=DEV].role[classCode=MANU] or\n.participation[typeCode=CSM].role[classCode=ADMM] (for Medication or Substance)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/Procedure.usedCode", "resource": { "resourceType": "DataElement", "id": "Procedure.usedCode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/Procedure.usedCode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "Procedure.usedCode", "path": "Procedure.usedCode", "short": "Coded items used during the procedure", "definition": "Identifies coded items that were used as part of the procedure.", "comment": "For devices actually implanted or removed, use Procedure.device.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureUsed" } ], "strength": "example", "description": "Codes describing items used during a procedure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/device-kind" } }, "mapping": [ { "identity": "rim", "map": "participation[typeCode=Dev].role[classCode=MANU]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List", "resource": { "resourceType": "DataElement", "id": "List", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List", "path": "List", "short": "Information summarized from a list of other resources", "definition": "A set of information summarized from a list of other resources.", "alias": [ "Collection", "WorkingList", "Organizer" ], "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "lst-2", "severity": "error", "human": "The deleted flag can only be used if the mode of the list is \"changes\"", "expression": "mode = 'changes' or entry.deleted.empty()", "xpath": "(f:mode/@value = 'changes') or not(exists(f:entry/f:deleted))" }, { "key": "lst-1", "severity": "error", "human": "A list can only have an emptyReason if it is empty", "expression": "emptyReason.empty() or entry.empty()", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[classCode<ORG,moodCode=EVN]" }, { "identity": "w5", "map": "infrastructure.documents" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.identifier", "resource": { "resourceType": "DataElement", "id": "List.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.identifier", "path": "List.identifier", "short": "Business identifier", "definition": "Identifier for the List assigned for business purposes outside the context of FHIR.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.status", "resource": { "resourceType": "DataElement", "id": "List.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.status", "path": "List.status", "short": "current | retired | entered-in-error", "definition": "Indicates the current state of this list.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListStatus" } ], "strength": "required", "description": "The current state of the list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-status" } }, "mapping": [ { "identity": "rim", "map": ".status[current=active;retired=obsolete;entered-in-error=nullified]" }, { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.mode", "resource": { "resourceType": "DataElement", "id": "List.mode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.mode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.mode", "path": "List.mode", "short": "working | snapshot | changes", "definition": "How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "comment": "This element is labeled as a modifier because a change list must not be mis-understood as a complete list.", "requirements": "Lists are used in various ways, and it must be known in what way it is safe to use them.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListMode" } ], "strength": "required", "description": "The processing mode that applies to this list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-mode" } }, "mapping": [ { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.title", "resource": { "resourceType": "DataElement", "id": "List.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.title", "path": "List.title", "short": "Descriptive name for the list", "definition": "A label for the list assigned by the author.", "requirements": "Allows customization beyond just the code identifying the kind of list.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Dr. Jane's Patients" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".title" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.code", "resource": { "resourceType": "DataElement", "id": "List.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.code", "path": "List.code", "short": "What the purpose of this list is", "definition": "This code defines the purpose of the list - why it was created.", "comment": "If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.", "requirements": "Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListPurpose" } ], "strength": "example", "description": "What the purpose of a list is", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-example-codes" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.subject", "resource": { "resourceType": "DataElement", "id": "List.subject", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.subject", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.subject", "path": "List.subject", "short": "If all resources have the same subject", "definition": "The common subject (or patient) of the resources that are in the list, if there is one.", "comment": "Some purely arbitrary lists do not have a common subject, so this is optional.", "requirements": "The primary purpose of listing the subject explicitly is to help with finding the right list.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode<SUB].role (and sometimes .player)" }, { "identity": "w5", "map": "who.focus" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.encounter", "resource": { "resourceType": "DataElement", "id": "List.encounter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.encounter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.encounter", "path": "List.encounter", "short": "Context in which list created", "definition": "The encounter that is the context in which this list was created.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" } ], "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.date", "resource": { "resourceType": "DataElement", "id": "List.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.date", "path": "List.date", "short": "When the list was prepared", "definition": "The date that the list was prepared.", "comment": "The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.", "requirements": "Identifies how current the list is which affects relevance.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode<AUT].time[type=TS]" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.source", "resource": { "resourceType": "DataElement", "id": "List.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.source", "path": "List.source", "short": "Who and/or what defined the list contents (aka Author)", "definition": "The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.", "comment": "The primary source is the entity that made the decisions what items are in the list. This may be software or user.", "requirements": "Allows follow-up as well as context.", "alias": [ "Author" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]" }, { "identity": "w5", "map": "who.author" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.orderedBy", "resource": { "resourceType": "DataElement", "id": "List.orderedBy", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.orderedBy", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.orderedBy", "path": "List.orderedBy", "short": "What order the list has", "definition": "What order applies to the items in the list.", "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListOrder" } ], "strength": "preferred", "description": "What order applies to the items in a list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-order" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.note", "resource": { "resourceType": "DataElement", "id": "List.note", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.note", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.note", "path": "List.note", "short": "Comments about the list", "definition": "Comments that apply to the overall list.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].act.text" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.entry", "resource": { "resourceType": "DataElement", "id": "List.entry", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.entry", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.entry", "path": "List.entry", "short": "Entries in the list", "definition": "Entries in this list.", "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "lst-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.entry.flag", "resource": { "resourceType": "DataElement", "id": "List.entry.flag", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.entry.flag", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.entry.flag", "path": "List.entry.flag", "short": "Status/Workflow information about this item", "definition": "The flag allows the system constructing the list to indicate the role and significance of the item in the list.", "comment": "The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is \"changes\".", "requirements": "This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListItemFlag" } ], "strength": "example", "description": "Codes that provide further information about the reason and meaning of the item in the list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-item-flag" } }, "mapping": [ { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.entry.deleted", "resource": { "resourceType": "DataElement", "id": "List.entry.deleted", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.entry.deleted", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.entry.deleted", "path": "List.entry.deleted", "short": "If this item is actually marked as deleted", "definition": "True if this item is marked as deleted in the list.", "comment": "If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is \"changes\". A deleted entry should be displayed in narrative as deleted.\n\nThis element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.", "requirements": "The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as \"deleted\".", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "condition": [ "lst-2" ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "added: .updateMode=(\"A\",\"AR\") retained: .updateMode=\"NC\" updated: .updateMode=\"R\" deleted: .updateMode=\"D\"" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.entry.date", "resource": { "resourceType": "DataElement", "id": "List.entry.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.entry.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.entry.date", "path": "List.entry.date", "short": "When item added to list", "definition": "When this item was added to the list.", "comment": "This is only useful and meaningful when the mode is \"working\".", "requirements": "The date may be significant for understanding the meaning of items in a working list.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "rim", "map": ".availabilityTime" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.entry.item", "resource": { "resourceType": "DataElement", "id": "List.entry.item", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.entry.item", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.entry.item", "path": "List.entry.item", "short": "Actual entry", "definition": "A reference to the actual resource from which data was derived.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "rim", "map": ".target or .role or .role.entity" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/List.emptyReason", "resource": { "resourceType": "DataElement", "id": "List.emptyReason", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/List.emptyReason", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "List.emptyReason", "path": "List.emptyReason", "short": "Why list is empty", "definition": "If the list is empty, why the list is empty.", "comment": "The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "lst-1" ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListEmptyReason" } ], "strength": "preferred", "description": "If a list is empty, why it is empty", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-empty-reason" } }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap", "resource": { "resourceType": "DataElement", "id": "ConceptMap", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap", "path": "ConceptMap", "short": "A map from one set of concepts to one or more other concepts", "definition": "A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "conformance.terminology" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.url", "resource": { "resourceType": "DataElement", "id": "ConceptMap.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.url", "path": "ConceptMap.url", "short": "Logical URI to reference this concept map (globally unique)", "definition": "An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the concept map to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.identifier", "resource": { "resourceType": "DataElement", "id": "ConceptMap.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.identifier", "path": "ConceptMap.identifier", "short": "Additional identifier for the concept map", "definition": "A formal identifier that is used to identify this concept map 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, e.g., to identify this concept map 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": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.version", "resource": { "resourceType": "DataElement", "id": "ConceptMap.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.version", "path": "ConceptMap.version", "short": "Business version of the concept map", "definition": "The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map 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 concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the concept map with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.name", "resource": { "resourceType": "DataElement", "id": "ConceptMap.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.name", "path": "ConceptMap.name", "short": "Name for this concept map (computer friendly)", "definition": "A natural language name identifying the concept map. 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 alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.title", "resource": { "resourceType": "DataElement", "id": "ConceptMap.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.title", "path": "ConceptMap.title", "short": "Name for this concept map (human friendly)", "definition": "A short, descriptive, user-friendly title for the concept map.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.status", "resource": { "resourceType": "DataElement", "id": "ConceptMap.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.status", "path": "ConceptMap.status", "short": "draft | active | retired | unknown", "definition": "The status of this concept map. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of concept maps that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired concept map without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.experimental", "resource": { "resourceType": "DataElement", "id": "ConceptMap.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.experimental", "path": "ConceptMap.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of concept map that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental concept map in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.date", "resource": { "resourceType": "DataElement", "id": "ConceptMap.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.date", "path": "ConceptMap.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the concept map was published. The date must change if and 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 concept map 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 concept map. 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" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.publisher", "resource": { "resourceType": "DataElement", "id": "ConceptMap.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.publisher", "path": "ConceptMap.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the concept map.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. 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 concept map. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the concept map. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.contact", "resource": { "resourceType": "DataElement", "id": "ConceptMap.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.contact", "path": "ConceptMap.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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.description", "resource": { "resourceType": "DataElement", "id": "ConceptMap.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.description", "path": "ConceptMap.description", "short": "Natural language description of the concept map", "definition": "A free text natural language description of the concept map from a consumer's perspective.", "comment": "The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.useContext", "resource": { "resourceType": "DataElement", "id": "ConceptMap.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.useContext", "path": "ConceptMap.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate concept map instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.jurisdiction", "resource": { "resourceType": "DataElement", "id": "ConceptMap.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.jurisdiction", "path": "ConceptMap.jurisdiction", "short": "Intended jurisdiction for concept map (if applicable)", "definition": "A legal or geographic region in which the concept map is intended to be used.", "comment": "It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.purpose", "resource": { "resourceType": "DataElement", "id": "ConceptMap.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.purpose", "path": "ConceptMap.purpose", "short": "Why this concept map is defined", "definition": "Explaination of why this concept map is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the concept map 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 concept map.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.copyright", "resource": { "resourceType": "DataElement", "id": "ConceptMap.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.copyright", "path": "ConceptMap.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.", "comment": "null Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.sourceX", "resource": { "resourceType": "DataElement", "id": "ConceptMap.sourceX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.sourceX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.source[x]", "path": "ConceptMap.source[x]", "short": "Identifies the source of the concepts which are being mapped", "definition": "The source value set that specifies the concepts that are being mapped.", "comment": "Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.", "min": 0, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.targetX", "resource": { "resourceType": "DataElement", "id": "ConceptMap.targetX", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.targetX", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.target[x]", "path": "ConceptMap.target[x]", "short": "Provides context to the mappings", "definition": "The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.", "comment": "Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.", "min": 0, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group", "path": "ConceptMap.group", "short": "Same source and target systems", "definition": "A group of mappings that all have the same source and target system.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.source", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.source", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.source", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.source", "path": "ConceptMap.group.source", "short": "Code System (if value set crosses code systems)", "definition": "An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).", "min": 0, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.sourceVersion", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.sourceVersion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.sourceVersion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.sourceVersion", "path": "ConceptMap.group.sourceVersion", "short": "Specific version of the code system", "definition": "The specific version of the code system, as determined by the code system authority.", "comment": "The specification of a particular code system version may be required for code systems which lack concept permanence.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.target", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.target", "path": "ConceptMap.group.target", "short": "System of the target (if necessary)", "definition": "An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).", "comment": "Target may be omitted if all the targget element equivalence values are 'unmatched'.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.targetVersion", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.targetVersion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.targetVersion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.targetVersion", "path": "ConceptMap.group.targetVersion", "short": "Specific version of the code system", "definition": "The specific version of the code system, as determined by the code system authority.", "comment": "The specification of a particular code system version may be required for code systems which lack concept permanence.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "SourceElement" } ], "path": "ConceptMap.group.element", "short": "Mappings for a concept from the source set", "definition": "Mappings for an individual concept in the source to one or more concepts in the target.", "comment": "Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.", "alias": [ "code", "concept", "item" ], "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.code", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.code", "path": "ConceptMap.group.element.code", "short": "Identifies element being mapped", "definition": "Identity (code or path) or the element/item being mapped.", "min": 0, "max": "1", "type": [ { "code": "code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.display", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.display", "path": "ConceptMap.group.element.display", "short": "Display for the code", "definition": "The display for the code. The display is only provided to help editors when editing the concept map.", "comment": "The display is ignored when processing the map.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "TargetElement" } ], "path": "ConceptMap.group.element.target", "short": "Concept in target system for element", "definition": "A concept from the target value set that this concept maps to.", "comment": "Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "cmd-1", "severity": "error", "human": "If the map is narrower or inexact, there SHALL be some comments", "expression": "comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))", "xpath": "exists(f:comment) or not(exists(f:equivalence)) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.code", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.code", "path": "ConceptMap.group.element.target.code", "short": "Code that identifies the target element", "definition": "Identity (code or path) or the element/item that the map refers to.", "min": 0, "max": "1", "type": [ { "code": "code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.display", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.display", "path": "ConceptMap.group.element.target.display", "short": "Display for the code", "definition": "The display for the code. The display is only provided to help editors when editing the concept map.", "comment": "The display is ignored when processing the map.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.equivalence", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.equivalence", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.equivalence", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.equivalence", "path": "ConceptMap.group.element.target.equivalence", "short": "relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint", "definition": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).", "comment": "This element is labeled as a modifier because it may indicate that a target does not apply.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "defaultValueCode": "equivalent", "isModifier": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConceptMapEquivalence" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The degree of equivalence between concepts.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/concept-map-equivalence" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.comment", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.comment", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.comment", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.comment", "path": "ConceptMap.group.element.target.comment", "short": "Description of status/issues in mapping", "definition": "A description of status/issues in mapping that conveys additional information not represented in the structured data.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "condition": [ "cmd-1" ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.dependsOn", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.dependsOn", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "OtherElement" } ], "path": "ConceptMap.group.element.target.dependsOn", "short": "Other elements required for this mapping (from context)", "definition": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.property", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.dependsOn.property", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.property", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.dependsOn.property", "path": "ConceptMap.group.element.target.dependsOn.property", "short": "Reference to property mapping depends on", "definition": "A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labeled to correspond with a code system property.", "min": 1, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.system", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.dependsOn.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.dependsOn.system", "path": "ConceptMap.group.element.target.dependsOn.system", "short": "Code System (if necessary)", "definition": "An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "meaningWhenMissing": "The code is in the source (dependsOn) or target (product) system" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.code", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.dependsOn.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.dependsOn.code", "path": "ConceptMap.group.element.target.dependsOn.code", "short": "Value of the referenced element", "definition": "Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.display", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.dependsOn.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.dependsOn.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.dependsOn.display", "path": "ConceptMap.group.element.target.dependsOn.display", "short": "Display for the code", "definition": "The display for the code. The display is only provided to help editors when editing the concept map.", "comment": "The display is ignored when processing the map.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.product", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.element.target.product", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.element.target.product", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.element.target.product", "path": "ConceptMap.group.element.target.product", "short": "Other concepts that this mapping also produces", "definition": "A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.", "min": 0, "max": "*", "contentReference": "#ConceptMap.group.element.target.dependsOn" } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.unmapped", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.unmapped", "path": "ConceptMap.group.unmapped", "short": "When no match in the mappings", "definition": "What to do when there is no match in the mappings in the group.", "comment": "This only applies if the source code is in the system defined for the group.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "cmd-3", "severity": "error", "human": "If the mode is 'other-map', a code must be provided", "expression": "(mode = 'other-map') implies url.exists()", "xpath": "(f:mode/@value != 'other-map') or exists(f:url)" }, { "key": "cmd-2", "severity": "error", "human": "If the mode is 'fixed', a code must be provided", "expression": "(mode = 'fixed') implies code.exists()", "xpath": "(f:mode/@value != 'fixed') or exists(f:code)" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.mode", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.unmapped.mode", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.mode", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.unmapped.mode", "path": "ConceptMap.group.unmapped.mode", "short": "provided | fixed | other-map", "definition": "Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConceptMapGroupUnmappedMode" } ], "strength": "required", "description": "Defines which action to take if there is no match in the group.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.code", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.unmapped.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.unmapped.code", "path": "ConceptMap.group.unmapped.code", "short": "Fixed code when mode = fixed", "definition": "The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.", "min": 0, "max": "1", "type": [ { "code": "code" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.display", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.unmapped.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.unmapped.display", "path": "ConceptMap.group.unmapped.display", "short": "Display for the code", "definition": "The display for the code. The display is only provided to help editors when editing the concept map.", "comment": "The display is ignored when processing the map.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.url", "resource": { "resourceType": "DataElement", "id": "ConceptMap.group.unmapped.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ConceptMap.group.unmapped.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ConceptMap.group.unmapped.url", "path": "ConceptMap.group.unmapped.url", "short": "Canonical URL for other concept map", "definition": "The canonical URL of the map to use if this map contains no mapping.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet", "resource": { "resourceType": "DataElement", "id": "ValueSet", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet", "path": "ValueSet", "short": "A set of codes drawn from one or more code systems", "definition": "A value set specifies a set of codes drawn from one or more code systems.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "vsd-5", "severity": "error", "human": "Value set SHALL contain at least one of a compose or an expansion element", "expression": "compose.exists() or expansion.exists()", "xpath": "exists(f:compose) or exists(f:expansion)" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "conformance.terminology" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.url", "resource": { "resourceType": "DataElement", "id": "ValueSet.url", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.url", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.url", "path": "ValueSet.url", "short": "Logical URI to reference this value set (globally unique)", "definition": "An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).", "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.", "requirements": "Allows the value set to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.identifier", "resource": { "resourceType": "DataElement", "id": "ValueSet.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.identifier", "path": "ValueSet.identifier", "short": "Additional identifier for the value set", "definition": "A formal identifier that is used to identify this value set 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, e.g., to identify this value set 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" } ], "isSummary": true, "mapping": [ { "identity": "define.xml2.0", "map": "Identifier part" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.version", "resource": { "resourceType": "DataElement", "id": "ValueSet.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.version", "path": "ValueSet.version", "short": "Business version of the value set", "definition": "The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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 value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the value set with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.name", "resource": { "resourceType": "DataElement", "id": "ValueSet.name", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.name", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.name", "path": "ValueSet.name", "short": "Name for this value set (computer friendly)", "definition": "A natural language name identifying the value set. 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 alpha-numeric type name to ensure that it is computable friendly. A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.", "requirements": "Support human navigation and code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.title", "resource": { "resourceType": "DataElement", "id": "ValueSet.title", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.title", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.title", "path": "ValueSet.title", "short": "Name for this value set (human friendly)", "definition": "A short, descriptive, user-friendly title for the value set.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.status", "resource": { "resourceType": "DataElement", "id": "ValueSet.status", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.status", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.status", "path": "ValueSet.status", "short": "draft | active | retired | unknown", "definition": "The status of this value set. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of value sets that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired value set without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "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 a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.experimental", "resource": { "resourceType": "DataElement", "id": "ValueSet.experimental", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.experimental", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.experimental", "path": "ValueSet.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of value set that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental value set in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.date", "resource": { "resourceType": "DataElement", "id": "ValueSet.date", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.date", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.date", "path": "ValueSet.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the value set was published. The date must change if and 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 value set changes. (e.g. the 'content logical definition').", "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set. 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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "w5", "map": "when.recorded" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.publisher", "resource": { "resourceType": "DataElement", "id": "ValueSet.publisher", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.publisher", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.publisher", "path": "ValueSet.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the value set.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. 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 value set. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the value set. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.contact", "resource": { "resourceType": "DataElement", "id": "ValueSet.contact", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.contact", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.contact", "path": "ValueSet.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" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.description", "resource": { "resourceType": "DataElement", "id": "ValueSet.description", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.description", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.description", "path": "ValueSet.description", "short": "Natural language description of the value set", "definition": "A free text natural language description of the value set from a consumer's perspective.", "comment": "This description can be used to capture details such as why the value set 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 value set 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 profile is presumed to be the predominant language in the place the profile was created). The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.", "alias": [ "Scope", "Purpose" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.useContext", "resource": { "resourceType": "DataElement", "id": "ValueSet.useContext", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.useContext", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.useContext", "path": "ValueSet.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate value set instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.jurisdiction", "resource": { "resourceType": "DataElement", "id": "ValueSet.jurisdiction", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.jurisdiction", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.jurisdiction", "path": "ValueSet.jurisdiction", "short": "Intended jurisdiction for value set (if applicable)", "definition": "A legal or geographic region in which the value set is intended to be used.", "comment": "It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "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", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.immutable", "resource": { "resourceType": "DataElement", "id": "ValueSet.immutable", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.immutable", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.immutable", "path": "ValueSet.immutable", "short": "Indicates whether or not any change to the content logical definition may occur", "definition": "If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.", "comment": "Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example \"All specializations of ACT in ActClassCode\" - Where there's no safe way to express the \"Purpose\" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.purpose", "resource": { "resourceType": "DataElement", "id": "ValueSet.purpose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.purpose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.purpose", "path": "ValueSet.purpose", "short": "Why this value set is defined", "definition": "Explaination of why this value set is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the value set 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 value set.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.copyright", "resource": { "resourceType": "DataElement", "id": "ValueSet.copyright", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.copyright", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.copyright", "path": "ValueSet.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.", "comment": "null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.extensible", "resource": { "resourceType": "DataElement", "id": "ValueSet.extensible", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.extensible", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.extensible", "path": "ValueSet.extensible", "short": "Whether this is intended to be used with an extensible binding", "definition": "Whether this is intended to be used with an extensible binding or not.", "requirements": "It is not required to say whether this intent applies.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose", "path": "ValueSet.compose", "short": "Definition of the content of the value set (CLD)", "definition": "A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the \"Content Logical Definition\" (CLD).", "alias": [ "Content Logical Definition" ], "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "condition": [ "vsd-5" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.lockedDate", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.lockedDate", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.lockedDate", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.lockedDate", "path": "ValueSet.compose.lockedDate", "short": "Fixed date for version-less references (transitive)", "definition": "If a locked date is defined, then the Content Logical Definition must be evaluated using the current version as of the locked date for referenced code system(s) and value set instances where ValueSet.compose.include.version is not defined.", "comment": "With a defined lockedDate the value set is considered \"Locked\". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.init" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.inactive", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.inactive", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.inactive", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.inactive", "path": "ValueSet.compose.inactive", "short": "Whether inactive codes are in the value set", "definition": "Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable ExpansionProfile (but generally, inactive codes would be expected to be included).", "comment": "Note that in the FHIR terminology framework, \"deprecated\" does not mean inactive, but in some code systems (e.g. LOINC, deprecated means inactive). Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ConceptSet" } ], "path": "ValueSet.compose.include", "short": "Include one or more codes from a code system or other value set(s)", "definition": "Include one or more codes from a code system or other value set(s).", "comment": "All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "vsd-2", "severity": "error", "human": "A value set with concepts or filters SHALL include a system", "expression": "(concept.exists() or filter.exists()) implies system.exists()", "xpath": "not(exists(f:concept) or exists(f:filter)) or exists(f:system)" }, { "key": "vsd-3", "severity": "error", "human": "Cannot have both concept and filter", "expression": "concept.empty() or filter.empty()", "xpath": "not(exists(f:concept)) or not(exists(f:filter))" }, { "key": "vsd-1", "severity": "error", "human": "A value set include/exclude SHALL have a value set or a system", "expression": "valueSet.exists() or system.exists()", "xpath": "exists(f:valueSet) or exists(f:system)" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.system", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.system", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.system", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.system", "path": "ValueSet.compose.include.system", "short": "The system the codes come from", "definition": "An absolute URI which is the code system from which the selected codes come from.", "comment": "If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "condition": [ "vsd-1", "vsd-2" ], "isSummary": true, "mapping": [ { "identity": "define.xml2.0", "map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Href" }, { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.version", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.version", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.version", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.version", "path": "ValueSet.compose.include.version", "short": "Specific version of the code system referred to", "definition": "The version of the code system that the codes are selected from.", "comment": "This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set may not be known until a context of use binds it to a particular version.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "define.xml2.0", "map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Version" }, { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.concept", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.concept", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ConceptReference" } ], "path": "ValueSet.compose.include.concept", "short": "A concept defined in the system", "definition": "Specifies a concept to be included or excluded.", "comment": "The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "vsd-3" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.code", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.concept.code", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.code", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.concept.code", "path": "ValueSet.compose.include.concept.code", "short": "Code or expression from system", "definition": "Specifies a code for the concept to be included or excluded.", "comment": "Expressions are allowed if defined by the underlying code system.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.display", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.concept.display", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.display", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.concept.display", "path": "ValueSet.compose.include.concept.display", "short": "Text to display for this code for this value set in this valueset", "definition": "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.", "comment": "The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.concept.designation", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.concept.designation", "path": "ValueSet.compose.include.concept.designation", "short": "Additional representations for this concept", "definition": "Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation.language", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.concept.designation.language", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation.language", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.concept.designation.language", "path": "ValueSet.compose.include.concept.designation.language", "short": "Human language of the designation", "definition": "The language this designation is defined for.", "comment": "In the absence of a language, the resource language applies.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation.use", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.concept.designation.use", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation.use", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.concept.designation.use", "path": "ValueSet.compose.include.concept.designation.use", "short": "Details how this designation would be used", "definition": "A code that details how this designation would be used.", "comment": "If no use is provided, the designation can be assumed to be suitable for general display to a human user.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConceptDesignationUse" } ], "strength": "extensible", "description": "Details of how a designation would be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/designation-use" } } } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation.value", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.concept.designation.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.concept.designation.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.concept.designation.value", "path": "ValueSet.compose.include.concept.designation.value", "short": "The text value for this designation", "definition": "The text value for this designation.", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.filter", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.filter", "path": "ValueSet.compose.include.filter", "short": "Select codes/concepts by their properties (including relationships)", "definition": "Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.", "comment": "Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "condition": [ "vsd-3" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter.property", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.filter.property", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter.property", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.filter.property", "path": "ValueSet.compose.include.filter.property", "short": "A property defined by the code system", "definition": "A code that identifies a property defined in the code system.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter.op", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.filter.op", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter.op", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.filter.op", "path": "ValueSet.compose.include.filter.op", "short": "= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists", "definition": "The kind of operation to perform as a part of the filter criteria.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FilterOperator" } ], "strength": "required", "description": "The kind of operation to perform as a part of a property based filter.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/filter-operator" } }, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter.value", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.filter.value", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.filter.value", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.filter.value", "path": "ValueSet.compose.include.filter.value", "short": "Code from the system, or regex criteria, or boolean value for exists", "definition": "The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.", "comment": "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.valueSet", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.include.valueSet", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.include.valueSet", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.include.valueSet", "path": "ValueSet.compose.include.valueSet", "short": "Select only contents included in this value set", "definition": "Selects concepts found in this value set. This is an absolute URI that is a reference to ValueSet.url.", "comment": "The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "condition": [ "vsd-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.compose.exclude", "resource": { "resourceType": "DataElement", "id": "ValueSet.compose.exclude", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.compose.exclude", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.compose.exclude", "path": "ValueSet.compose.exclude", "short": "Explicitly exclude codes from a code system or other value sets", "definition": "Exclude one or more codes from the value set based on code system filters and/or other value sets.", "comment": "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.", "min": 0, "max": "*", "contentReference": "#ValueSet.compose.include", "condition": [ "vsd-2" ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.expansion", "resource": { "resourceType": "DataElement", "id": "ValueSet.expansion", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.expansion", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.expansion", "path": "ValueSet.expansion", "short": "Used when the value set is \"expanded\"", "definition": "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.", "comment": "Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "condition": [ "vsd-5" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.expansion.identifier", "resource": { "resourceType": "DataElement", "id": "ValueSet.expansion.identifier", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.expansion.identifier", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.expansion.identifier", "path": "ValueSet.expansion.identifier", "short": "Uniquely identifies this expansion", "definition": "An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.", "comment": "Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).", "min": 1, "max": "1", "type": [ { "code": "uri" } ] } ] } }, { "fullUrl": "http://hl7.org/fhir/DataElement/ValueSet.expansion.timestamp", "resource": { "resourceType": "DataElement", "id": "ValueSet.expansion.timestamp", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "url": "http://hl7.org/fhir/DataElement/ValueSet.expansion.timestamp", "status": "draft", "experimental": true, "stringency": "fully-specified", "element": [ { "id": "ValueSet.expansion.timestamp", "path": "ValueSet.expansion.timestamp", "short": "Time ValueSet expansion happened", "definition": "The time at which the expansion was produced by the expanding system.", "comment"