{ "resourceType": "Bundle", "id": "types", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "type": "collection", "entry": [ { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Element", "resource": { "resourceType": "StructureDefinition", "id": "Element", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Element In/aBase for all elements
+ All FHIR elements must have a @value or children
\".\"\".\"\".\" id 0..1stringxml:id (or equivalent in JSON)
\".\"\".\"\".\" extension 0..*ExtensionAdditional Content defined by implementations

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Element", "name": "Element", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Element Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": true, "type": "Element", "snapshot": { "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" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/BackboneElement", "resource": { "resourceType": "StructureDefinition", "id": "BackboneElement", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" BackboneElement ElementBase for elements defined inside a resource
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/BackboneElement", "name": "BackboneElement", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for BackboneElement Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": true, "type": "BackboneElement", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "BackboneElement.id", "path": "BackboneElement.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "BackboneElement.extension", "path": "BackboneElement.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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/StructureDefinition/base64Binary", "resource": { "resourceType": "StructureDefinition", "id": "base64Binary", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/base64Binary", "name": "base64Binary", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for base64Binary Type: A stream of bytes", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "base64Binary", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "base64Binary.extension", "path": "base64Binary.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "element": [ { "id": "base64Binary", "path": "base64Binary", "short": "Primitive Type base64Binary", "definition": "A stream of bytes", "comment": "A stream of bytes, base64 encoded", "min": 0, "max": "*" }, { "id": "base64Binary.value", "path": "base64Binary.value", "representation": [ "xmlAttr" ], "short": "Primitive value for base64Binary", "definition": "Primitive value for base64Binary", "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/StructureDefinition/boolean", "resource": { "resourceType": "StructureDefinition", "id": "boolean", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/boolean", "name": "boolean", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for boolean Type: Value of \"true\" or \"false\"", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "boolean", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "boolean.extension", "path": "boolean.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "element": [ { "id": "boolean", "path": "boolean", "short": "Primitive Type boolean", "definition": "Value of \"true\" or \"false\"", "min": 0, "max": "*" }, { "id": "boolean.value", "path": "boolean.value", "representation": [ "xmlAttr" ], "short": "Primitive value for boolean", "definition": "Primitive value for boolean", "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/StructureDefinition/code", "resource": { "resourceType": "StructureDefinition", "id": "code", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/code", "name": "code", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for code type: A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "code", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/string", "derivation": "specialization", "snapshot": { "element": [ { "id": "code", "path": "code", "short": "Primitive Type code", "definition": "A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents", "min": 0, "max": "*", "base": { "path": "code", "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" } ] }, { "id": "code.id", "path": "code.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" } ] }, { "id": "code.extension", "path": "code.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "code.value", "path": "code.value", "representation": [ "xmlAttr" ], "short": "Primitive value for code", "definition": "Primitive value for code", "min": 0, "max": "1", "base": { "path": "string.value", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[^\\s]+([\\s]?[^\\s]+)*" } ], "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:token" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:token" } ] } } ] } ] }, "differential": { "element": [ { "id": "code", "path": "code", "short": "Primitive Type code", "definition": "A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents", "min": 0, "max": "*" }, { "id": "code.value", "path": "code.value", "representation": [ "xmlAttr" ], "short": "Primitive value for code", "definition": "Primitive value for code", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[^\\s]+([\\s]?[^\\s]+)*" } ], "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:token" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:token" } ] } } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/date", "resource": { "resourceType": "StructureDefinition", "id": "date", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/date", "name": "date", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for date Type: 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.", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "date", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "date.extension", "path": "date.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "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": "*" }, { "id": "date.value", "path": "date.value", "representation": [ "xmlAttr" ], "short": "Primitive value for date", "definition": "Primitive value for date", "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/StructureDefinition/dateTime", "resource": { "resourceType": "StructureDefinition", "id": "dateTime", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/dateTime", "name": "dateTime", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for dateTime Type: 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.", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "dateTime", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "dateTime.extension", "path": "dateTime.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "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": "*" }, { "id": "dateTime.value", "path": "dateTime.value", "representation": [ "xmlAttr" ], "short": "Primitive value for dateTime", "definition": "Primitive value for dateTime", "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/StructureDefinition/decimal", "resource": { "resourceType": "StructureDefinition", "id": "decimal", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/decimal", "name": "decimal", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for decimal Type: A rational number with implicit precision", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "decimal", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "decimal.extension", "path": "decimal.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "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": "*" }, { "id": "decimal.value", "path": "decimal.value", "representation": [ "xmlAttr" ], "short": "Primitive value for decimal", "definition": "Primitive value for decimal", "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/StructureDefinition/id", "resource": { "resourceType": "StructureDefinition", "id": "id", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/id", "name": "id", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for id type: Any combination of letters, numerals, \"-\" and \".\", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "id", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/string", "derivation": "specialization", "snapshot": { "element": [ { "id": "id", "path": "id", "short": "Primitive Type id", "definition": "Any combination of letters, numerals, \"-\" and \".\", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.", "comment": "RFC 4122", "min": 0, "max": "*", "base": { "path": "id", "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" } ] }, { "id": "id.id", "path": "id.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" } ] }, { "id": "id.extension", "path": "id.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "id.value", "path": "id.value", "representation": [ "xmlAttr" ], "short": "Primitive value for id", "definition": "Primitive value for id", "min": 0, "max": "1", "base": { "path": "string.value", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[A-Za-z0-9\\-\\.]{1,64}" } ], "_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" } ] } } ] } ] }, "differential": { "element": [ { "id": "id", "path": "id", "short": "Primitive Type id", "definition": "Any combination of letters, numerals, \"-\" and \".\", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.", "comment": "RFC 4122", "min": 0, "max": "*" }, { "id": "id.value", "path": "id.value", "representation": [ "xmlAttr" ], "short": "Primitive value for id", "definition": "Primitive value for id", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[A-Za-z0-9\\-\\.]{1,64}" } ], "_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" } ] } } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/instant", "resource": { "resourceType": "StructureDefinition", "id": "instant", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/instant", "name": "instant", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for instant Type: An instant in time - known at least to the second", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "instant", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "instant.extension", "path": "instant.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "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": "*" }, { "id": "instant.value", "path": "instant.value", "representation": [ "xmlAttr" ], "short": "Primitive value for instant", "definition": "Primitive value for instant", "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/StructureDefinition/integer", "resource": { "resourceType": "StructureDefinition", "id": "integer", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/integer", "name": "integer", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for integer Type: A whole number", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "integer", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "integer.extension", "path": "integer.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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 } ] }, "differential": { "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": "*" }, { "id": "integer.value", "path": "integer.value", "representation": [ "xmlAttr" ], "short": "Primitive value for integer", "definition": "Primitive value for integer", "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/StructureDefinition/markdown", "resource": { "resourceType": "StructureDefinition", "id": "markdown", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/markdown", "name": "markdown", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for markdown type: A string that may contain markdown syntax for optional processing by a mark down presentation engine", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "markdown", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/string", "derivation": "specialization", "snapshot": { "element": [ { "id": "markdown", "path": "markdown", "short": "Primitive Type markdown", "definition": "A string that may contain markdown syntax for optional processing by a mark down presentation engine", "comment": "Systems are not required to have markdown support, and there is considerable variation in markdown syntax, so the text should be readable without markdown processing. The preferred markdown syntax is described here: http://daringfireball.net/projects/markdown/syntax (and tests here: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip)", "min": 0, "max": "*", "base": { "path": "markdown", "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" } ] }, { "id": "markdown.id", "path": "markdown.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" } ] }, { "id": "markdown.extension", "path": "markdown.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "markdown.value", "path": "markdown.value", "representation": [ "xmlAttr" ], "short": "Primitive value for markdown", "definition": "Primitive value for markdown", "min": 0, "max": "1", "base": { "path": "string.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" } ] } } ] } ] }, "differential": { "element": [ { "id": "markdown", "path": "markdown", "short": "Primitive Type markdown", "definition": "A string that may contain markdown syntax for optional processing by a mark down presentation engine", "comment": "Systems are not required to have markdown support, and there is considerable variation in markdown syntax, so the text should be readable without markdown processing. The preferred markdown syntax is described here: http://daringfireball.net/projects/markdown/syntax (and tests here: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip)", "min": 0, "max": "*" }, { "id": "markdown.value", "path": "markdown.value", "representation": [ "xmlAttr" ], "short": "Primitive value for markdown", "definition": "Primitive value for markdown", "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" } ] } } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/oid", "resource": { "resourceType": "StructureDefinition", "id": "oid", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/oid", "name": "oid", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for oid type: An OID represented as a URI", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "oid", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/uri", "derivation": "specialization", "snapshot": { "element": [ { "id": "oid", "path": "oid", "short": "Primitive Type oid", "definition": "An OID represented as a URI", "comment": "RFC 3001. See also ISO/IEC 8824:1990 €", "min": 0, "max": "*", "base": { "path": "oid", "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" } ] }, { "id": "oid.id", "path": "oid.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" } ] }, { "id": "oid.extension", "path": "oid.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "oid.value", "path": "oid.value", "representation": [ "xmlAttr" ], "short": "Primitive value for oid", "definition": "Primitive value for oid", "min": 0, "max": "1", "base": { "path": "uri.value", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "urn:oid:(0|[1-9][0-9]*)(\\.(0|[1-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:anyURI" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:string" } ] } } ] } ] }, "differential": { "element": [ { "id": "oid", "path": "oid", "short": "Primitive Type oid", "definition": "An OID represented as a URI", "comment": "RFC 3001. See also ISO/IEC 8824:1990 €", "min": 0, "max": "*" }, { "id": "oid.value", "path": "oid.value", "representation": [ "xmlAttr" ], "short": "Primitive value for oid", "definition": "Primitive value for oid", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "urn:oid:(0|[1-9][0-9]*)(\\.(0|[1-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:anyURI" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:string" } ] } } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/positiveInt", "resource": { "resourceType": "StructureDefinition", "id": "positiveInt", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/positiveInt", "name": "positiveInt", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for positiveInt type: An integer with a value that is positive (e.g. >0)", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "positiveInt", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/integer", "derivation": "specialization", "snapshot": { "element": [ { "id": "positiveInt", "path": "positiveInt", "short": "Primitive Type positiveInt", "definition": "An integer with a value that is positive (e.g. >0)", "min": 0, "max": "*", "base": { "path": "positiveInt", "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" } ] }, { "id": "positiveInt.id", "path": "positiveInt.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" } ] }, { "id": "positiveInt.extension", "path": "positiveInt.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "positiveInt.value", "path": "positiveInt.value", "representation": [ "xmlAttr" ], "short": "Primitive value for positiveInt", "definition": "Primitive value for positiveInt", "min": 0, "max": "1", "base": { "path": "integer.value", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[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:positiveInteger" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:positiveInteger" } ] } } ] } ] }, "differential": { "element": [ { "id": "positiveInt", "path": "positiveInt", "short": "Primitive Type positiveInt", "definition": "An integer with a value that is positive (e.g. >0)", "min": 0, "max": "*" }, { "id": "positiveInt.value", "path": "positiveInt.value", "representation": [ "xmlAttr" ], "short": "Primitive value for positiveInt", "definition": "Primitive value for positiveInt", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[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:positiveInteger" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:positiveInteger" } ] } } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/string", "resource": { "resourceType": "StructureDefinition", "id": "string", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/string", "name": "string", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for string Type: A sequence of Unicode characters", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "string", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "string.extension", "path": "string.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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 } ] }, "differential": { "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": "*" }, { "id": "string.value", "path": "string.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "definition": "Primitive value for string", "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/StructureDefinition/time", "resource": { "resourceType": "StructureDefinition", "id": "time", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/time", "name": "time", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for time Type: A time during the day, with no date specified", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "time", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "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" } ] }, { "id": "time.extension", "path": "time.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "element": [ { "id": "time", "path": "time", "short": "Primitive Type time", "definition": "A time during the day, with no date specified", "min": 0, "max": "*" }, { "id": "time.value", "path": "time.value", "representation": [ "xmlAttr" ], "short": "Primitive value for time", "definition": "Primitive value for time", "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/StructureDefinition/unsignedInt", "resource": { "resourceType": "StructureDefinition", "id": "unsignedInt", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/unsignedInt", "name": "unsignedInt", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for unsignedInt type: An integer with a value that is not negative (e.g. >= 0)", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "unsignedInt", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/integer", "derivation": "specialization", "snapshot": { "element": [ { "id": "unsignedInt", "path": "unsignedInt", "short": "Primitive Type unsignedInt", "definition": "An integer with a value that is not negative (e.g. >= 0)", "min": 0, "max": "*", "base": { "path": "unsignedInt", "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" } ] }, { "id": "unsignedInt.id", "path": "unsignedInt.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" } ] }, { "id": "unsignedInt.extension", "path": "unsignedInt.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "unsignedInt.value", "path": "unsignedInt.value", "representation": [ "xmlAttr" ], "short": "Primitive value for unsignedInt", "definition": "Primitive value for unsignedInt", "min": 0, "max": "1", "base": { "path": "integer.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:nonNegativeInteger" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:nonNegativeInteger" } ] } } ] } ] }, "differential": { "element": [ { "id": "unsignedInt", "path": "unsignedInt", "short": "Primitive Type unsignedInt", "definition": "An integer with a value that is not negative (e.g. >= 0)", "min": 0, "max": "*" }, { "id": "unsignedInt.value", "path": "unsignedInt.value", "representation": [ "xmlAttr" ], "short": "Primitive value for unsignedInt", "definition": "Primitive value for unsignedInt", "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:nonNegativeInteger" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:nonNegativeInteger" } ] } } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/uri", "resource": { "resourceType": "StructureDefinition", "id": "uri", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/uri", "name": "uri", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for uri Type: String of characters used to identify a name or a resource", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "uri", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "element": [ { "id": "uri", "path": "uri", "short": "Primitive Type uri", "definition": "String of characters used to identify a name or a resource", "comment": "see http://en.wikipedia.org/wiki/Uniform_resource_identifier", "min": 0, "max": "*", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ] }, { "id": "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" } ] }, { "id": "uri.extension", "path": "uri.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "element": [ { "id": "uri", "path": "uri", "short": "Primitive Type uri", "definition": "String of characters used to identify a name or a resource", "comment": "see http://en.wikipedia.org/wiki/Uniform_resource_identifier", "min": 0, "max": "*" }, { "id": "uri.value", "path": "uri.value", "representation": [ "xmlAttr" ], "short": "Primitive value for uri", "definition": "Primitive value for uri", "min": 0, "max": "1", "type": [ { "_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/StructureDefinition/uuid", "resource": { "resourceType": "StructureDefinition", "id": "uuid", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/uuid", "name": "uuid", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for uuid type: A UUID, represented as a URI", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "uuid", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/uri", "derivation": "specialization", "snapshot": { "element": [ { "id": "uuid", "path": "uuid", "short": "Primitive Type uuid", "definition": "A UUID, represented as a URI", "comment": "See The Open Group, CDE 1.1 Remote Procedure Call specification, Appendix A.", "min": 0, "max": "*", "base": { "path": "uuid", "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" } ] }, { "id": "uuid.id", "path": "uuid.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" } ] }, { "id": "uuid.extension", "path": "uuid.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "uuid.value", "path": "uuid.value", "representation": [ "xmlAttr" ], "short": "Primitive value for uuid", "definition": "Primitive value for uuid", "min": 0, "max": "1", "base": { "path": "uri.value", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" } ], "_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" } ] } } ] } ] }, "differential": { "element": [ { "id": "uuid", "path": "uuid", "short": "Primitive Type uuid", "definition": "A UUID, represented as a URI", "comment": "See The Open Group, CDE 1.1 Remote Procedure Call specification, Appendix A.", "min": 0, "max": "*" }, { "id": "uuid.value", "path": "uuid.value", "representation": [ "xmlAttr" ], "short": "Primitive value for uuid", "definition": "Primitive value for uuid", "min": 0, "max": "1", "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" } ], "_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/StructureDefinition/xhtml", "resource": { "resourceType": "StructureDefinition", "id": "xhtml", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
to do
" }, "url": "http://hl7.org/fhir/StructureDefinition/xhtml", "name": "xhtml", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for xhtml Type", "fhirVersion": "3.0.1", "kind": "primitive-type", "abstract": false, "type": "xhtml", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "element": [ { "id": "xhtml", "path": "xhtml", "short": "Primitive Type xhtml", "definition": "XHTML", "min": 0, "max": "*" }, { "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" } ] }, { "id": "xhtml.extension", "path": "xhtml.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "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" } ] } } ] } ] }, "differential": { "element": [ { "id": "xhtml", "path": "xhtml", "short": "Primitive Type xhtml", "definition": "XHTML", "min": 0, "max": "*" }, { "id": "xhtml.extension", "path": "xhtml.extension", "max": "0" }, { "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/StructureDefinition/Address", "resource": { "resourceType": "StructureDefinition", "id": "Address", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Address ΣElementAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" use ?!Σ0..1codehome | work | temp | old - purpose of this address
AddressUse (Required)
\".\"\".\"\".\" type Σ0..1codepostal | physical | both
AddressType (Required)
\".\"\".\"\".\" text Σ0..1stringText representation of the address
\".\"\".\"\".\" line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
\".\"\".\"\".\" city Σ0..1stringName of city, town etc.
\".\"\".\"\".\" district Σ0..1stringDistrict name (aka county)
\".\"\".\"\".\" state Σ0..1stringSub-unit of country (abbreviations ok)
\".\"\".\"\".\" postalCode Σ0..1stringPostal code for area
\".\"\".\"\".\" country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
\".\"\".\"\".\" period Σ0..1PeriodTime period when address was/is in use

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Address", "name": "Address", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Address Type", "purpose": "Need to be able to record postal addresses, along with notes about their use.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" }, { "identity": "vcard", "uri": "http://w3.org/vcard", "name": "vCard Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Address", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Address.id", "path": "Address.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Address.extension", "path": "Address.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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" } ] }, { "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]" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "v2", "map": "XAD" }, { "identity": "rim", "map": "AD" }, { "identity": "servd", "map": "Address" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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" } ] }, { "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]" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Age", "resource": { "resourceType": "StructureDefinition", "id": "Age", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Age ΣIQuantityA duration of time during which an organism (or a process) has existed
+ 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.
Elements defined in Ancestors: id, extension, value, comparator, unit, system, code

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Age", "name": "Age", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Age Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Age", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Quantity", "derivation": "specialization", "snapshot": { "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, MO, CO, depending on the values" }, { "identity": "rim", "map": "PQ" } ] }, { "id": "Age.id", "path": "Age.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Age.extension", "path": "Age.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Age.value", "path": "Age.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", "base": { "path": "Quantity.value", "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" } ] }, { "id": "Age.comparator", "path": "Age.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", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "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" } ] }, { "id": "Age.unit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Age.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", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "id": "Age.system", "path": "Age.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", "base": { "path": "Quantity.system", "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" } ] }, { "id": "Age.code", "path": "Age.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", "base": { "path": "Quantity.code", "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" } ] } ] }, "differential": { "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.", "min": 0, "max": "*", "constraint": [ { "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": "rim", "map": "PQ" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Annotation", "resource": { "resourceType": "StructureDefinition", "id": "Annotation", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Annotation ElementText node with attribution
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" author[x] Σ0..1Individual responsible for the annotation
\".\"\".\"\".\"\".\" authorReferenceReference(Practitioner | Patient | RelatedPerson)
\".\"\".\"\".\"\".\" authorStringstring
\".\"\".\"\".\" time Σ0..1dateTimeWhen the annotation was made
\".\"\".\"\".\" text 1..1stringThe annotation - text content

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Annotation", "name": "Annotation", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Annotation Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Annotation", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Annotation.id", "path": "Annotation.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Annotation.extension", "path": "Annotation.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" } ] }, { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/Attachment", "resource": { "resourceType": "StructureDefinition", "id": "Attachment", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Attachment IElementContent in a format defined elsewhere
+ It the Attachment has data, it SHALL have a contentType
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" contentType Σ0..1codeMime type of the content, with charset etc.
MimeType (Required)
\".\"\".\"\".\" language Σ0..1codeHuman language of the content (BCP-47)
Common Languages (Extensible but limited to All Languages)
\".\"\".\"\".\" data 0..1base64BinaryData inline, base64ed
\".\"\".\"\".\" url Σ0..1uriUri where the data can be found
\".\"\".\"\".\" size Σ0..1unsignedIntNumber of bytes of content (if url provided)
\".\"\".\"\".\" hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
\".\"\".\"\".\" title Σ0..1stringLabel to display in place of the data
\".\"\".\"\".\" creation Σ0..1dateTimeDate attachment was first created

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Attachment", "name": "Attachment", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Attachment Type", "purpose": "Many models need to include data defined in other specifications that is complex and opaque to the healthcare model. This includes documents, media recordings, structured data, etc.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Attachment", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Attachment.id", "path": "Attachment.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Attachment.extension", "path": "Attachment.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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\"]" } ] }, { "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" } ] }, { "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)" } ] } ] }, "differential": { "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": "*", "constraint": [ { "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": "v2", "map": "ED/RP" }, { "identity": "rim", "map": "ED" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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\"]" } ] }, { "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" } ] }, { "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/StructureDefinition/CodeableConcept", "resource": { "resourceType": "StructureDefinition", "id": "CodeableConcept", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" CodeableConcept ΣElementConcept - reference to a terminology or just text
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" coding Σ0..*CodingCode defined by a terminology system
\".\"\".\"\".\" text Σ0..1stringPlain text representation of the concept

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/CodeableConcept", "name": "CodeableConcept", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for CodeableConcept Type", "purpose": "This is a common pattern in healthcare - a concept that may be defined by one or more codes from formal definitions including LOINC and SNOMED CT, and/or defined by the provision of text that captures a human sense of the concept.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "orim", "uri": "http://hl7.org/orim", "name": "Ontological RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "CodeableConcept", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "CodeableConcept.id", "path": "CodeableConcept.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CodeableConcept.extension", "path": "CodeableConcept.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" } ] }, { "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" } ] }, { "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/StructureDefinition/Coding", "resource": { "resourceType": "StructureDefinition", "id": "Coding", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Coding ΣElementA reference to a code defined by a terminology system
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" system Σ0..1uriIdentity of the terminology system
\".\"\".\"\".\" version Σ0..1stringVersion of the system - if relevant
\".\"\".\"\".\" code Σ0..1codeSymbol in syntax defined by the system
\".\"\".\"\".\" display Σ0..1stringRepresentation defined by the system
\".\"\".\"\".\" userSelected Σ0..1booleanIf this coding was chosen directly by the user

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Coding", "name": "Coding", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Coding Type", "purpose": "References to codes are very common in healthcare models.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "orim", "uri": "http://hl7.org/orim", "name": "Ontological RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Coding", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Coding.id", "path": "Coding.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Coding.extension", "path": "Coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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 ]" } ] } ] }, "differential": { "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": "*", "mapping": [ { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/ContactDetail", "resource": { "resourceType": "StructureDefinition", "id": "ContactDetail", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" ContactDetail ΣElementContact information
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" name Σ0..1stringName of an individual to contact
\".\"\".\"\".\" telecom Σ0..*ContactPointContact details for individual or organization

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/ContactDetail", "name": "ContactDetail", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for ContactDetail Type", "purpose": "Need to track contact information in the same way across multiple resources.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "ContactDetail", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "ContactDetail.id", "path": "ContactDetail.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ContactDetail.extension", "path": "ContactDetail.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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 }, { "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 } ] }, "differential": { "element": [ { "id": "ContactDetail", "path": "ContactDetail", "short": "Contact information", "definition": "Specifies contact information for a person or organization.", "min": 0, "max": "*" }, { "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 }, { "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/StructureDefinition/ContactPoint", "resource": { "resourceType": "StructureDefinition", "id": "ContactPoint", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" ContactPoint ΣIElementDetails of a Technology mediated contact point (phone, fax, email, etc.)
+ A system is required if a value is provided.
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" system ΣI0..1codephone | fax | email | pager | url | sms | other
ContactPointSystem (Required)
\".\"\".\"\".\" value Σ0..1stringThe actual contact point details
\".\"\".\"\".\" use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
ContactPointUse (Required)
\".\"\".\"\".\" rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
\".\"\".\"\".\" period Σ0..1PeriodTime period when the contact point was/is in use

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/ContactPoint", "name": "ContactPoint", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for ContactPoint Type", "purpose": "Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" } ], "kind": "complex-type", "abstract": false, "type": "ContactPoint", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "ContactPoint.id", "path": "ContactPoint.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ContactPoint.extension", "path": "ContactPoint.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] }, "differential": { "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": "*", "constraint": [ { "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": "v2", "map": "XTN" }, { "identity": "rim", "map": "TEL" }, { "identity": "servd", "map": "ContactPoint" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Contributor", "resource": { "resourceType": "StructureDefinition", "id": "Contributor", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Contributor ΣElementContributor information
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" type Σ1..1codeauthor | editor | reviewer | endorser
ContributorType (Required)
\".\"\".\"\".\" name Σ1..1stringWho contributed the content
\".\"\".\"\".\" contact Σ0..*ContactDetailContact details of the contributor

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Contributor", "name": "Contributor", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Contributor Type", "purpose": "Need to track contributor information in the same way across multiple resources.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Contributor", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Contributor.id", "path": "Contributor.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Contributor.extension", "path": "Contributor.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } } }, { "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 }, { "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 } ] }, "differential": { "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": "*" }, { "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" } } }, { "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 }, { "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/StructureDefinition/Count", "resource": { "resourceType": "StructureDefinition", "id": "Count", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Count ΣIQuantityA measured or measurable amount
+ 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.
Elements defined in Ancestors: id, extension, value, comparator, unit, system, code

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Count", "name": "Count", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Count Type", "purpose": "Need to able to capture all sorts of measured values, even if the measured value are not precisely quantified. Values include exact measures such as 3.51g, customary units such as 3 tablets, and currencies such as $100.32USD.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Count", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Quantity", "derivation": "specialization", "snapshot": { "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, MO, CO, depending on the values" } ] }, { "id": "Count.id", "path": "Count.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Count.extension", "path": "Count.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Count.value", "path": "Count.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", "base": { "path": "Quantity.value", "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" } ] }, { "id": "Count.comparator", "path": "Count.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", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "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" } ] }, { "id": "Count.unit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Count.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", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "id": "Count.system", "path": "Count.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", "base": { "path": "Quantity.system", "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" } ] }, { "id": "Count.code", "path": "Count.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", "base": { "path": "Quantity.code", "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" } ] } ] }, "differential": { "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": "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, MO, CO, depending on the values" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/DataRequirement", "resource": { "resourceType": "StructureDefinition", "id": "DataRequirement", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" DataRequirement ΣElementDescribes a required data item
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" type Σ1..1codeThe type of the required data
FHIRAllTypes (Required)
\".\"\".\"\".\" profile Σ0..*uriThe profile of the required data
\".\"\".\"\".\" mustSupport Σ0..*stringIndicates that specific structure elements are referenced by the knowledge module
\".\"\".\"\".\" codeFilter Σ0..*ElementWhat codes are expected
\".\"\".\"\".\"\".\" path Σ1..1stringThe code-valued attribute of the filter
\".\"\".\"\".\"\".\" valueSet[x] Σ0..1Valueset for the filter
\".\"\".\"\".\"\".\"\".\" valueSetStringstring
\".\"\".\"\".\"\".\"\".\" valueSetReferenceReference(ValueSet)
\".\"\".\"\".\"\".\" valueCode Σ0..*codeWhat code is expected
\".\"\".\"\".\"\".\" valueCoding Σ0..*CodingWhat Coding is expected
\".\"\".\"\".\"\".\" valueCodeableConcept Σ0..*CodeableConceptWhat CodeableConcept is expected
\".\"\".\"\".\" dateFilter Σ0..*ElementWhat dates/date ranges are expected
\".\"\".\"\".\"\".\" path Σ1..1stringThe date-valued attribute of the filter
\".\"\".\"\".\"\".\" value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
\".\"\".\"\".\"\".\"\".\" valueDateTimedateTime
\".\"\".\"\".\"\".\"\".\" valuePeriodPeriod
\".\"\".\"\".\"\".\"\".\" valueDurationDuration

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/DataRequirement", "name": "DataRequirement", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for DataRequirement Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "DataRequirement", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "DataRequirement.id", "path": "DataRequirement.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "DataRequirement.extension", "path": "DataRequirement.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } } }, { "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 }, { "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 }, { "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 }, { "id": "DataRequirement.codeFilter.id", "path": "DataRequirement.codeFilter.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "DataRequirement.codeFilter.extension", "path": "DataRequirement.codeFilter.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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 }, { "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 }, { "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 }, { "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 }, { "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 }, { "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 }, { "id": "DataRequirement.dateFilter.id", "path": "DataRequirement.dateFilter.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "DataRequirement.dateFilter.extension", "path": "DataRequirement.dateFilter.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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 }, { "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 } ] }, "differential": { "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": "*" }, { "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" } } }, { "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 }, { "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 }, { "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" } ], "isSummary": true }, { "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 }, { "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 }, { "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 }, { "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 }, { "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 }, { "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" } ], "isSummary": true }, { "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 }, { "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/StructureDefinition/Distance", "resource": { "resourceType": "StructureDefinition", "id": "Distance", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Distance ΣIQuantityA length - a value with a unit that is a physical distance
+ 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.
Elements defined in Ancestors: id, extension, value, comparator, unit, system, code

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Distance", "name": "Distance", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Distance Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Distance", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Quantity", "derivation": "specialization", "snapshot": { "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, MO, CO, depending on the values" }, { "identity": "rim", "map": "PQ" } ] }, { "id": "Distance.id", "path": "Distance.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Distance.extension", "path": "Distance.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Distance.value", "path": "Distance.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", "base": { "path": "Quantity.value", "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" } ] }, { "id": "Distance.comparator", "path": "Distance.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", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "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" } ] }, { "id": "Distance.unit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Distance.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", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "id": "Distance.system", "path": "Distance.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", "base": { "path": "Quantity.system", "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" } ] }, { "id": "Distance.code", "path": "Distance.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", "base": { "path": "Quantity.code", "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" } ] } ] }, "differential": { "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.", "min": 0, "max": "*", "constraint": [ { "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": "rim", "map": "PQ" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Dosage", "resource": { "resourceType": "StructureDefinition", "id": "Dosage", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Dosage ΣElementHow the medication is/was taken or should be taken
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" sequence Σ0..1integerThe order of the dosage instructions
\".\"\".\"\".\" text Σ0..1stringFree text dosage instructions e.g. SIG
\".\"\".\"\".\" additionalInstruction Σ0..*CodeableConceptSupplemental instruction - e.g. "with meals"
SNOMED CT Additional Dosage Instructions (Example)
\".\"\".\"\".\" patientInstruction Σ0..1stringPatient or consumer oriented instructions
\".\"\".\"\".\" timing Σ0..1TimingWhen medication should be administered
\".\"\".\"\".\" asNeeded[x] Σ0..1Take "as needed" (for x)
SNOMED CT Medication As Needed Reason Codes (Example)
\".\"\".\"\".\"\".\" asNeededBooleanboolean
\".\"\".\"\".\"\".\" asNeededCodeableConceptCodeableConcept
\".\"\".\"\".\" site Σ0..1CodeableConceptBody site to administer to
SNOMED CT Anatomical Structure for Administration Site Codes (Example)
\".\"\".\"\".\" route Σ0..1CodeableConceptHow drug should enter body
SNOMED CT Route Codes (Example)
\".\"\".\"\".\" method Σ0..1CodeableConceptTechnique for administering medication
SNOMED CT Administration Method Codes (Example)
\".\"\".\"\".\" dose[x] Σ0..1Amount of medication per dose
\".\"\".\"\".\"\".\" doseRangeRange
\".\"\".\"\".\"\".\" doseQuantitySimpleQuantity
\".\"\".\"\".\" maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
\".\"\".\"\".\" maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
\".\"\".\"\".\" maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
\".\"\".\"\".\" rate[x] Σ0..1Amount of medication per unit of time
\".\"\".\"\".\"\".\" rateRatioRatio
\".\"\".\"\".\"\".\" rateRangeRange
\".\"\".\"\".\"\".\" rateQuantitySimpleQuantity

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Dosage", "name": "Dosage", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Dosage Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Dosage", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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]" } ] }, { "id": "Dosage.id", "path": "Dosage.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Dosage.extension", "path": "Dosage.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/Duration", "resource": { "resourceType": "StructureDefinition", "id": "Duration", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Duration ΣIQuantityA length of time
+ 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.
Elements defined in Ancestors: id, extension, value, comparator, unit, system, code

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Duration", "name": "Duration", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Duration Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Duration", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Quantity", "derivation": "specialization", "snapshot": { "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, MO, CO, depending on the values" }, { "identity": "rim", "map": "PQ, IVL depending on the values" } ] }, { "id": "Duration.id", "path": "Duration.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Duration.extension", "path": "Duration.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Duration.value", "path": "Duration.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", "base": { "path": "Quantity.value", "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" } ] }, { "id": "Duration.comparator", "path": "Duration.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", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "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" } ] }, { "id": "Duration.unit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Duration.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", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "id": "Duration.system", "path": "Duration.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", "base": { "path": "Quantity.system", "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" } ] }, { "id": "Duration.code", "path": "Duration.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", "base": { "path": "Quantity.code", "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" } ] } ] }, "differential": { "element": [ { "id": "Duration", "path": "Duration", "short": "A length of time", "definition": "A length of time.", "min": 0, "max": "*", "constraint": [ { "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": "rim", "map": "PQ, IVL depending on the values" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/ElementDefinition", "resource": { "resourceType": "StructureDefinition", "id": "ElementDefinition", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" ElementDefinition ΣIElementDefinition of an element in a resource or extension
+ Min <= Max
+ if the element definition has a contentReference, it cannot have type, defaultValue, fixed, pattern, example, minValue, maxValue, maxLength, or binding
+ Pattern may only be specified if there is one type
+ Fixed value may only be specified if there is one type
+ Binding can only be present for coded elements, string, and uri
+ Pattern and value are mutually exclusive
+ Constraints must be unique by key
+ Types must be unique by the combination of code and profile
+ sliceName must be composed of proper tokens separated by "/"
+ default value and meaningWhenMissing are mutually exclusive
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" path Σ1..1stringPath of the element in the hierarchy of elements
\".\"\".\"\".\" representation Σ0..*codexmlAttr | xmlText | typeAttr | cdaText | xhtml
PropertyRepresentation (Required)
\".\"\".\"\".\" sliceName Σ0..1stringName for this particular element (in a set of slices)
\".\"\".\"\".\" label Σ0..1stringName for element to display with or prompt for element
\".\"\".\"\".\" code Σ0..*CodingCorresponding codes in terminologies
LOINC Codes (Example)
\".\"\".\"\".\" slicing ΣI0..1ElementThis element is sliced - slices follow
+ If there are no discriminators, there must be a definition
\".\"\".\"\".\"\".\" discriminator Σ0..*ElementElement values that are used to distinguish the slices
\".\"\".\"\".\"\".\"\".\" type Σ1..1codevalue | exists | pattern | type | profile
DiscriminatorType (Required)
\".\"\".\"\".\"\".\"\".\" path Σ1..1stringPath to element value
\".\"\".\"\".\"\".\" description ΣI0..1stringText description of how slicing works (or not)
\".\"\".\"\".\"\".\" ordered Σ0..1booleanIf elements must be in same order as slices
\".\"\".\"\".\"\".\" rules Σ1..1codeclosed | open | openAtEnd
SlicingRules (Required)
\".\"\".\"\".\" short Σ0..1stringConcise definition for space-constrained presentation
\".\"\".\"\".\" definition Σ0..1markdownFull formal definition as narrative text
\".\"\".\"\".\" comment Σ0..1markdownComments about the use of this element
\".\"\".\"\".\" requirements Σ0..1markdownWhy this resource has been created
\".\"\".\"\".\" alias Σ0..*stringOther names
\".\"\".\"\".\" min ΣI0..1unsignedIntMinimum Cardinality
\".\"\".\"\".\" max ΣI0..1stringMaximum Cardinality (a number or *)
+ Max SHALL be a number or "*"
\".\"\".\"\".\" base Σ0..1ElementBase definition information for tools
\".\"\".\"\".\"\".\" path Σ1..1stringPath that identifies the base element
\".\"\".\"\".\"\".\" min Σ1..1unsignedIntMin cardinality of the base element
\".\"\".\"\".\"\".\" max Σ1..1stringMax cardinality of the base element
\".\"\".\"\".\" contentReference ΣI0..1uriReference to definition of content for the element
\".\"\".\"\".\" type ΣI0..*ElementData type and Profile for this element
+ Aggregation may only be specified if one of the allowed types for the element is a resource
\".\"\".\"\".\"\".\" code Σ1..1uriData type or Resource (reference to definition)
FHIRDefinedType (Extensible)
\".\"\".\"\".\"\".\" profile Σ0..1uriProfile (StructureDefinition) to apply (or IG)
\".\"\".\"\".\"\".\" targetProfile Σ0..1uriProfile (StructureDefinition) to apply to reference target (or IG)
\".\"\".\"\".\"\".\" aggregation ΣI0..*codecontained | referenced | bundled - how aggregated
AggregationMode (Required)
\".\"\".\"\".\"\".\" versioning Σ0..1codeeither | independent | specific
ReferenceVersionRules (Required)
\".\"\".\"\".\" defaultValue[x] ΣI0..1*Specified value if missing from instance
\".\"\".\"\".\" meaningWhenMissing ΣI0..1markdownImplicit meaning when this element is missing
\".\"\".\"\".\" orderMeaning Σ0..1stringWhat the order of the elements means
\".\"\".\"\".\" fixed[x] ΣI0..1*Value must be exactly this
\".\"\".\"\".\" pattern[x] ΣI0..1*Value must have at least these property values
\".\"\".\"\".\" example Σ0..*ElementExample value (as defined for type)
\".\"\".\"\".\"\".\" label Σ1..1stringDescribes the purpose of this example
\".\"\".\"\".\"\".\" value[x] Σ1..1*Value of Example (one of allowed types)
\".\"\".\"\".\" minValue[x] Σ0..1Minimum Allowed Value (for some types)
\".\"\".\"\".\"\".\" minValueDatedate
\".\"\".\"\".\"\".\" minValueDateTimedateTime
\".\"\".\"\".\"\".\" minValueInstantinstant
\".\"\".\"\".\"\".\" minValueTimetime
\".\"\".\"\".\"\".\" minValueDecimaldecimal
\".\"\".\"\".\"\".\" minValueIntegerinteger
\".\"\".\"\".\"\".\" minValuePositiveIntpositiveInt
\".\"\".\"\".\"\".\" minValueUnsignedIntunsignedInt
\".\"\".\"\".\"\".\" minValueQuantityQuantity
\".\"\".\"\".\" maxValue[x] Σ0..1Maximum Allowed Value (for some types)
\".\"\".\"\".\"\".\" maxValueDatedate
\".\"\".\"\".\"\".\" maxValueDateTimedateTime
\".\"\".\"\".\"\".\" maxValueInstantinstant
\".\"\".\"\".\"\".\" maxValueTimetime
\".\"\".\"\".\"\".\" maxValueDecimaldecimal
\".\"\".\"\".\"\".\" maxValueIntegerinteger
\".\"\".\"\".\"\".\" maxValuePositiveIntpositiveInt
\".\"\".\"\".\"\".\" maxValueUnsignedIntunsignedInt
\".\"\".\"\".\"\".\" maxValueQuantityQuantity
\".\"\".\"\".\" maxLength Σ0..1integerMax length for strings
\".\"\".\"\".\" condition Σ0..*idReference to invariant about presence
\".\"\".\"\".\" constraint Σ0..*ElementCondition that must evaluate to true
\".\"\".\"\".\"\".\" key ΣI1..1idTarget of 'condition' reference above
\".\"\".\"\".\"\".\" requirements Σ0..1stringWhy this constraint is necessary or appropriate
\".\"\".\"\".\"\".\" severity Σ1..1codeerror | warning
ConstraintSeverity (Required)
\".\"\".\"\".\"\".\" human Σ1..1stringHuman description of constraint
\".\"\".\"\".\"\".\" expression Σ1..1stringFHIRPath expression of constraint
\".\"\".\"\".\"\".\" xpath Σ0..1stringXPath expression of constraint
\".\"\".\"\".\"\".\" source Σ0..1uriReference to original source of constraint
\".\"\".\"\".\" mustSupport Σ0..1booleanIf the element must supported
\".\"\".\"\".\" isModifier Σ0..1booleanIf this modifies the meaning of other elements
\".\"\".\"\".\" isSummary Σ0..1booleanInclude when _summary = true?
\".\"\".\"\".\" binding ΣI0..1ElementValueSet details if this is coded
+ provide either a reference or a description (or both)
+ ValueSet as a URI SHALL start with http:// or https:// or urn:
\".\"\".\"\".\"\".\" strength Σ1..1coderequired | extensible | preferred | example
BindingStrength (Required)
\".\"\".\"\".\"\".\" description ΣI0..1stringHuman explanation of the value set
\".\"\".\"\".\"\".\" valueSet[x] ΣI0..1Source of value set
\".\"\".\"\".\"\".\"\".\" valueSetUriuri
\".\"\".\"\".\"\".\"\".\" valueSetReferenceReference(ValueSet)
\".\"\".\"\".\" mapping Σ0..*ElementMap element to another set of definitions
\".\"\".\"\".\"\".\" identity Σ1..1idReference to mapping declaration
\".\"\".\"\".\"\".\" language Σ0..1codeComputable language of mapping
MimeType (Required)
\".\"\".\"\".\"\".\" map Σ1..1stringDetails of the mapping
\".\"\".\"\".\"\".\" comment Σ0..1stringComments about the mapping or its use

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/ElementDefinition", "name": "ElementDefinition", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for ElementDefinition Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "dex", "uri": "http://wiki.ihe.net/index.php?title=Data_Element_Exchange", "name": "IHE Data Element Exchange (DEX)" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "iso11179", "uri": "http://metadata-standards.org/11179/", "name": "ISO 11179" }, { "identity": "loinc", "uri": "http://loinc.org", "name": "LOINC code for the element" } ], "kind": "complex-type", "abstract": false, "type": "ElementDefinition", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "ElementDefinition.id", "path": "ElementDefinition.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.extension", "path": "ElementDefinition.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "id": "ElementDefinition.slicing.id", "path": "ElementDefinition.slicing.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.slicing.extension", "path": "ElementDefinition.slicing.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "id": "ElementDefinition.slicing.discriminator.id", "path": "ElementDefinition.slicing.discriminator.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.slicing.discriminator.extension", "path": "ElementDefinition.slicing.discriminator.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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?" } ] }, { "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?" } ] }, { "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" } ] }, { "id": "ElementDefinition.base.id", "path": "ElementDefinition.base.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.base.extension", "path": "ElementDefinition.base.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "id": "ElementDefinition.type.id", "path": "ElementDefinition.type.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.type.extension", "path": "ElementDefinition.type.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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)" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "id": "ElementDefinition.example.id", "path": "ElementDefinition.example.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.example.extension", "path": "ElementDefinition.example.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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)" } ] }, { "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" } ] }, { "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)" } ] }, { "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)" } ] }, { "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" } ] }, { "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)" } ] }, { "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": "??" } ] }, { "id": "ElementDefinition.constraint.id", "path": "ElementDefinition.constraint.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.constraint.extension", "path": "ElementDefinition.constraint.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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": "??" } ] }, { "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": "??" } ] }, { "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": "??" } ] }, { "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" } ] }, { "id": "ElementDefinition.binding.id", "path": "ElementDefinition.binding.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.binding.extension", "path": "ElementDefinition.binding.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "id": "ElementDefinition.mapping.id", "path": "ElementDefinition.mapping.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ElementDefinition.mapping.extension", "path": "ElementDefinition.mapping.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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)" } ] }, { "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)" } ] }, { "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" } ] }, { "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)" } ] } ] }, "differential": { "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": "*", "constraint": [ { "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": "dex", "map": "RetrieveMetadata response" }, { "identity": "v2", "map": "OM1" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=DEFN]" }, { "identity": "iso11179", "map": "Data_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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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": "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" } ] }, { "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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "iso11179", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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?" } ] }, { "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?" } ] }, { "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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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": "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)" } ] }, { "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)" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" } ] }, { "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)" } ] }, { "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" } ] }, { "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)" } ] }, { "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)" } ] }, { "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" } ] }, { "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)" } ] }, { "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" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A (MIF territory)" }, { "identity": "iso11179", "map": "??" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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": "??" } ] }, { "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": "??" } ] }, { "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": "??" } ] }, { "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": "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ], "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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" } ] }, { "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/StructureDefinition/Extension", "resource": { "resourceType": "StructureDefinition", "id": "Extension", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Extension IElementOptional Extensions Element
+ Must have either extensions or value[x], not both
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" url 1..1uriidentifies the meaning of the extension
\".\"\".\"\".\" value[x] 0..1*Value of extension

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Extension", "name": "Extension", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Extension Type", "purpose": "The ability to add extensions in a structured way is what keeps FHIR resources simple.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Extension.id", "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "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" } ] }, { "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" } ] } ] }, "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "min": 0, "max": "*", "constraint": [ { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension.url", "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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/StructureDefinition/HumanName", "resource": { "resourceType": "StructureDefinition", "id": "HumanName", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" HumanName ΣElementName of a human - parts and usage
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
NameUse (Required)
\".\"\".\"\".\" text Σ0..1stringText representation of the full name
\".\"\".\"\".\" family Σ0..1stringFamily name (often called 'Surname')
\".\"\".\"\".\" given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
\".\"\".\"\".\" prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
\".\"\".\"\".\" suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
\".\"\".\"\".\" period Σ0..1PeriodTime period when name was/is in use

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/HumanName", "name": "HumanName", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for HumanName Type", "purpose": "Need to be able to record names, along with notes about their use.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" } ], "kind": "complex-type", "abstract": false, "type": "HumanName", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "HumanName.id", "path": "HumanName.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "HumanName.extension", "path": "HumanName.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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]" } ] }, { "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\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "v2", "map": "XPN" }, { "identity": "rim", "map": "EN (actually, PN)" }, { "identity": "servd", "map": "ProviderName" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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]" } ] }, { "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\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Identifier", "resource": { "resourceType": "StructureDefinition", "id": "Identifier", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Identifier ΣElementAn identifier intended for computation
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" use ?!Σ0..1codeusual | official | temp | secondary (If known)
IdentifierUse (Required)
\".\"\".\"\".\" type Σ0..1CodeableConceptDescription of identifier
Identifier Type Codes (Extensible)
\".\"\".\"\".\" system Σ0..1uriThe namespace for the identifier value
\".\"\".\"\".\" value Σ0..1stringThe value that is unique
\".\"\".\"\".\" period Σ0..1PeriodTime period when id is/was valid for use
\".\"\".\"\".\" assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Identifier", "name": "Identifier", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Identifier Type", "purpose": "Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" } ], "kind": "complex-type", "abstract": false, "type": "Identifier", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Identifier.id", "path": "Identifier.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Identifier.extension", "path": "Identifier.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "element": [ { "id": "Identifier", "path": "Identifier", "short": "An identifier intended for computation", "definition": "A technical identifier - identifies some entity uniquely and unambiguously.", "min": 0, "max": "*", "mapping": [ { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/Meta", "resource": { "resourceType": "StructureDefinition", "id": "Meta", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Meta ΣElementMetadata about a resource
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" versionId Σ0..1idVersion specific identifier
\".\"\".\"\".\" lastUpdated Σ0..1instantWhen the resource version last changed
\".\"\".\"\".\" profile Σ0..*uriProfiles this resource claims to conform to
\".\"\".\"\".\" security Σ0..*CodingSecurity Labels applied to this resource
All Security Labels (Extensible)
\".\"\".\"\".\" tag Σ0..*CodingTags applied to this resource
Common Tags (Example)

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Meta", "name": "Meta", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Meta Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Meta", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Meta.id", "path": "Meta.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Meta.extension", "path": "Meta.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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 }, { "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 }, { "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 }, { "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" } } }, { "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" } } } ] }, "differential": { "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": "*", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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 }, { "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 }, { "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 }, { "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" } } }, { "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/StructureDefinition/Money", "resource": { "resourceType": "StructureDefinition", "id": "Money", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Money ΣIQuantityAn amount of economic utility in some recognized currency
+ 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).
Elements defined in Ancestors: id, extension, value, comparator, unit, system, code

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Money", "name": "Money", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Money Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Money", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Quantity", "derivation": "specialization", "snapshot": { "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, MO, CO, depending on the values" }, { "identity": "rim", "map": "MO" } ] }, { "id": "Money.id", "path": "Money.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Money.extension", "path": "Money.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Money.value", "path": "Money.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", "base": { "path": "Quantity.value", "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" } ] }, { "id": "Money.comparator", "path": "Money.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", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "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" } ] }, { "id": "Money.unit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Money.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", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "id": "Money.system", "path": "Money.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", "base": { "path": "Quantity.system", "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" } ] }, { "id": "Money.code", "path": "Money.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", "base": { "path": "Quantity.code", "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" } ] } ] }, "differential": { "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.", "min": 0, "max": "*", "constraint": [ { "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": "rim", "map": "MO" } ] } ] } } }, { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Narrative", "resource": { "resourceType": "StructureDefinition", "id": "Narrative", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Narrative ElementA human-readable formatted text, including images
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" status 1..1codegenerated | extensions | additional | empty
NarrativeStatus (Required)
\".\"\".\"\".\" div I1..1xhtmlLimited xhtml content
+ 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
+ The narrative SHALL have some non-whitespace content

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Narrative", "name": "Narrative", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Narrative Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Narrative", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Narrative.id", "path": "Narrative.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Narrative.extension", "path": "Narrative.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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, 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, 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" } ] } ] }, "differential": { "element": [ { "id": "Narrative", "path": "Narrative", "short": "A human-readable formatted text, including images", "definition": "A human-readable formatted text, including images.", "min": 0, "max": "*", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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" } ] }, { "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, 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, 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/StructureDefinition/ParameterDefinition", "resource": { "resourceType": "StructureDefinition", "id": "ParameterDefinition", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" ParameterDefinition ΣElementDefinition of a parameter to a module
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" name Σ0..1codeName used to access the parameter value
\".\"\".\"\".\" use Σ1..1codein | out
OperationParameterUse (Required)
\".\"\".\"\".\" min Σ0..1integerMinimum cardinality
\".\"\".\"\".\" max Σ0..1stringMaximum cardinality (a number of *)
\".\"\".\"\".\" documentation Σ0..1stringA brief description of the parameter
\".\"\".\"\".\" type Σ1..1codeWhat type of value
FHIRAllTypes (Required)
\".\"\".\"\".\" profile Σ0..1Reference(StructureDefinition)What profile the value is expected to be

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/ParameterDefinition", "name": "ParameterDefinition", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for ParameterDefinition Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "ParameterDefinition", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "ParameterDefinition.id", "path": "ParameterDefinition.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ParameterDefinition.extension", "path": "ParameterDefinition.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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 }, { "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" } } }, { "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 }, { "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 }, { "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 }, { "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" } } }, { "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 } ] }, "differential": { "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": "*" }, { "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 }, { "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" } } }, { "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 }, { "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 }, { "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 }, { "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" } } }, { "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/StructureDefinition/Period", "resource": { "resourceType": "StructureDefinition", "id": "Period", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Period ΣIElementTime range defined by start and end date/time
+ If present, start SHALL have a lower value than end
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" start ΣI0..1dateTimeStarting time with inclusive boundary
\".\"\".\"\".\" end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Period", "name": "Period", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Period Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Period", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" } ] }, { "id": "Period.id", "path": "Period.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Period.extension", "path": "Period.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "constraint": [ { "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": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" } ] }, { "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" } ] }, { "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/StructureDefinition/Quantity", "resource": { "resourceType": "StructureDefinition", "id": "Quantity", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Quantity ΣIElementA measured or measurable amount
+ If a code for the unit is present, the system SHALL also be present
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" value Σ0..1decimalNumerical value (with implicit precision)
\".\"\".\"\".\" comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
QuantityComparator (Required)
\".\"\".\"\".\" unit Σ0..1stringUnit representation
\".\"\".\"\".\" system ΣI0..1uriSystem that defines coded unit form
\".\"\".\"\".\" code Σ0..1codeCoded form of the unit

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Quantity", "name": "Quantity", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Quantity Type", "purpose": "Need to able to capture all sorts of measured values, even if the measured value are not precisely quantified. Values include exact measures such as 3.51g, customary units such as 3 tablets, and currencies such as $100.32USD.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Quantity", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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, MO, CO, depending on the values" } ] }, { "id": "Quantity.id", "path": "Quantity.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Quantity.extension", "path": "Quantity.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "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)" } ], "mapping": [ { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL, MO, CO, depending on the values" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/Range", "resource": { "resourceType": "StructureDefinition", "id": "Range", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Range ΣIElementSet of values bounded by low and high
+ If present, low SHALL have a lower value than high
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" low ΣI0..1SimpleQuantityLow limit
\".\"\".\"\".\" high ΣI0..1SimpleQuantityHigh limit

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Range", "name": "Range", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Range Type", "purpose": "Need to be able to specify ranges of values.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Range", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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 [lowClosed=\"true\" and highClosed=\"true\"]or URG" } ] }, { "id": "Range.id", "path": "Range.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Range.extension", "path": "Range.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "constraint": [ { "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": "v2", "map": "NR and also possibly SN (but see also quantity)" }, { "identity": "rim", "map": "IVL [lowClosed=\"true\" and highClosed=\"true\"]or URG" } ] }, { "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" } ] }, { "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/StructureDefinition/Ratio", "resource": { "resourceType": "StructureDefinition", "id": "Ratio", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Ratio ΣIElementA ratio of two Quantity values - a numerator and a denominator
+ Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" numerator Σ0..1QuantityNumerator value
\".\"\".\"\".\" denominator Σ0..1QuantityDenominator value

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Ratio", "name": "Ratio", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Ratio Type", "purpose": "Need to able to capture ratios for some measurements (titers) and some rates (costs).", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Ratio", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Ratio.id", "path": "Ratio.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Ratio.extension", "path": "Ratio.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "constraint": [ { "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": "v2", "map": "N/A" }, { "identity": "rim", "map": "RTO" } ] }, { "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" } ] }, { "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/StructureDefinition/Reference", "resource": { "resourceType": "StructureDefinition", "id": "Reference", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Reference ΣIElementA reference from one resource to another
+ SHALL have a contained resource if a local reference is provided
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
\".\"\".\"\".\" identifier Σ0..1IdentifierLogical reference, when literal reference is not known
\".\"\".\"\".\" display Σ0..1stringText alternative for the resource

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Reference", "name": "Reference", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Reference Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Reference", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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)" } ] }, { "id": "Reference.id", "path": "Reference.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Reference.extension", "path": "Reference.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "constraint": [ { "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": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" } ] }, { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/RelatedArtifact", "resource": { "resourceType": "StructureDefinition", "id": "RelatedArtifact", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" RelatedArtifact ΣElementRelated artifacts for a knowledge resource
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
RelatedArtifactType (Required)
\".\"\".\"\".\" display Σ0..1stringBrief description of the related artifact
\".\"\".\"\".\" citation Σ0..1stringBibliographic citation for the artifact
\".\"\".\"\".\" url Σ0..1uriWhere the artifact can be accessed
\".\"\".\"\".\" document Σ0..1AttachmentWhat document is being referenced
\".\"\".\"\".\" resource Σ0..1Reference(Any)What resource is being referenced

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/RelatedArtifact", "name": "RelatedArtifact", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for RelatedArtifact Type", "purpose": "Knowledge resources 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.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "RelatedArtifact", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "RelatedArtifact.id", "path": "RelatedArtifact.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedArtifact.extension", "path": "RelatedArtifact.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } } }, { "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 }, { "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 }, { "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 }, { "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 }, { "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 } ] }, "differential": { "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": "*" }, { "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" } } }, { "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 }, { "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 }, { "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 }, { "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 }, { "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/StructureDefinition/SampledData", "resource": { "resourceType": "StructureDefinition", "id": "SampledData", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" SampledData ElementA series of measurements taken by a device
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" origin Σ1..1SimpleQuantityZero value and units
\".\"\".\"\".\" period Σ1..1decimalNumber of milliseconds between samples
\".\"\".\"\".\" factor Σ0..1decimalMultiply data by this before adding to origin
\".\"\".\"\".\" lowerLimit Σ0..1decimalLower limit of detection
\".\"\".\"\".\" upperLimit Σ0..1decimalUpper limit of detection
\".\"\".\"\".\" dimensions Σ1..1positiveIntNumber of sample points at each time point
\".\"\".\"\".\" data 1..1stringDecimal values with spaces, or "E" | "U" | "L"

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/SampledData", "name": "SampledData", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for SampledData Type", "purpose": "There is a need for a concise way to handle the data produced by devices that sample a physical state at a high frequency.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "SampledData", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "SampledData.id", "path": "SampledData.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "SampledData.extension", "path": "SampledData.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "v2", "map": "N/A (but see section 7.14 in v2.7)" }, { "identity": "rim", "map": "SLIST + GLIST" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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)" } ] }, { "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)" } ] }, { "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)" } ] }, { "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/StructureDefinition/Signature", "resource": { "resourceType": "StructureDefinition", "id": "Signature", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Signature ElementA digital Signature - XML DigSig, JWT, Graphical image of signature, etc.
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" type Σ1..*CodingIndication of the reason the entity signed the object(s)
Signature Type Codes (Preferred)
\".\"\".\"\".\" when Σ1..1instantWhen the signature was created
\".\"\".\"\".\" who[x] Σ1..1Who signed
\".\"\".\"\".\"\".\" whoUriuri
\".\"\".\"\".\"\".\" whoReferenceReference(Practitioner | RelatedPerson | Patient | Device | Organization)
\".\"\".\"\".\" onBehalfOf[x] Σ0..1The party represented
\".\"\".\"\".\"\".\" onBehalfOfUriuri
\".\"\".\"\".\"\".\" onBehalfOfReferenceReference(Practitioner | RelatedPerson | Patient | Device | Organization)
\".\"\".\"\".\" contentType Σ0..1codeThe technical format of the signature
MimeType (Required)
\".\"\".\"\".\" blob 0..1base64BinaryThe actual signature content (XML DigSig. JWT, picture, etc.)

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Signature", "name": "Signature", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Signature Type", "purpose": "There are a number of places where content must be signed in healthcare.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Signature", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "Signature.id", "path": "Signature.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Signature.extension", "path": "Signature.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "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" } } }, { "id": "Signature.when", "path": "Signature.when", "short": "When the signature was created", "definition": "When the digital signature was signed.", "comment": "This should agree with the information in the signature.", "min": 1, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true }, { "id": "Signature.who[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 }, { "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 }, { "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" } }, { "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" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Signature.type", "path": "Signature.type", "short": "Indication of the reason the entity signed the object(s)", "definition": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.", "comment": "Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".", "min": 1, "max": "*", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/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" } } }, { "id": "Signature.when", "path": "Signature.when", "short": "When the signature was created", "definition": "When the digital signature was signed.", "comment": "This should agree with the information in the signature.", "min": 1, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true }, { "id": "Signature.who[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 }, { "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 }, { "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" } }, { "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/StructureDefinition/Timing", "resource": { "resourceType": "StructureDefinition", "id": "Timing", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Timing ΣElementA timing schedule that specifies an event that may occur multiple times
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" event Σ0..*dateTimeWhen the event occurs
\".\"\".\"\".\" repeat ΣI0..1ElementWhen the event is to occur
+ If there's an offset, there must be a when (and not C, CM, CD, CV)
+ period SHALL be a non-negative value
+ If there's a periodMax, there must be a period
+ If there's a durationMax, there must be a duration
+ If there's a countMax, there must be a count
+ if there's a duration, there needs to be duration units
+ If there's a timeOfDay, there cannot be be a when, or vice versa
+ if there's a period, there needs to be period units
+ duration SHALL be a non-negative value
\".\"\".\"\".\"\".\" bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
\".\"\".\"\".\"\".\"\".\" boundsDurationDuration
\".\"\".\"\".\"\".\"\".\" boundsRangeRange
\".\"\".\"\".\"\".\"\".\" boundsPeriodPeriod
\".\"\".\"\".\"\".\" count Σ0..1integerNumber of times to repeat
\".\"\".\"\".\"\".\" countMax Σ0..1integerMaximum number of times to repeat
\".\"\".\"\".\"\".\" duration Σ0..1decimalHow long when it happens
\".\"\".\"\".\"\".\" durationMax Σ0..1decimalHow long when it happens (Max)
\".\"\".\"\".\"\".\" durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
UnitsOfTime (Required)
\".\"\".\"\".\"\".\" frequency Σ0..1integerEvent occurs frequency times per period
\".\"\".\"\".\"\".\" frequencyMax Σ0..1integerEvent occurs up to frequencyMax times per period
\".\"\".\"\".\"\".\" period Σ0..1decimalEvent occurs frequency times per period
\".\"\".\"\".\"\".\" periodMax Σ0..1decimalUpper limit of period (3-4 hours)
\".\"\".\"\".\"\".\" periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
UnitsOfTime (Required)
\".\"\".\"\".\"\".\" dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
\".\"\".\"\".\"\".\" timeOfDay Σ0..*timeTime of day for action
\".\"\".\"\".\"\".\" when Σ0..*codeRegular life events the event is tied to
EventTiming (Required)
\".\"\".\"\".\"\".\" offset Σ0..1unsignedIntMinutes from event (before or after)
\".\"\".\"\".\" code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H +
TimingAbbreviation (Preferred)

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/Timing", "name": "Timing", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for Timing Type", "purpose": "Need to able to track proposed timing schedules. There are several different ways to do this: one or more specified times, a simple rules like three times a day, or before/after meals.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Timing", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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 (GTS)" } ] }, { "id": "Timing.id", "path": "Timing.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Timing.extension", "path": "Timing.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "id": "Timing.repeat.id", "path": "Timing.repeat.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Timing.repeat.extension", "path": "Timing.repeat.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] } ] }, "differential": { "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": "*", "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "QSET (GTS)" } ] }, { "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" } ] }, { "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": "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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" } ] }, { "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/StructureDefinition/TriggerDefinition", "resource": { "resourceType": "StructureDefinition", "id": "TriggerDefinition", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" TriggerDefinition ΣElementDefines an expected trigger for a module
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" type Σ1..1codenamed-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended
TriggerType (Required)
\".\"\".\"\".\" eventName Σ0..1stringTriggering event name
\".\"\".\"\".\" eventTiming[x] Σ0..1Timing of the event
\".\"\".\"\".\"\".\" eventTimingTimingTiming
\".\"\".\"\".\"\".\" eventTimingReferenceReference(Schedule)
\".\"\".\"\".\"\".\" eventTimingDatedate
\".\"\".\"\".\"\".\" eventTimingDateTimedateTime
\".\"\".\"\".\" eventData Σ0..1DataRequirementTriggering data of the event

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition", "name": "TriggerDefinition", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for TriggerDefinition Type", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "TriggerDefinition", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "TriggerDefinition.id", "path": "TriggerDefinition.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "TriggerDefinition.extension", "path": "TriggerDefinition.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } } }, { "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 }, { "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 }, { "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 } ] }, "differential": { "element": [ { "id": "TriggerDefinition", "path": "TriggerDefinition", "short": "Defines an expected trigger for a module", "definition": "A description of a triggering event.", "min": 0, "max": "*" }, { "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" } } }, { "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 }, { "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 }, { "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/StructureDefinition/UsageContext", "resource": { "resourceType": "StructureDefinition", "id": "UsageContext", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" UsageContext ΣElementDescribes the context of use for a conformance or knowledge resource
Elements defined in Ancestors: id, extension
\".\"\".\"\".\" code Σ1..1CodingType of context being specified
UsageContextType (Extensible)
\".\"\".\"\".\" value[x] Σ1..1Value that defines the context
Context of Use ValueSet (Example)
\".\"\".\"\".\"\".\" valueCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\" valueQuantityQuantity
\".\"\".\"\".\"\".\" valueRangeRange

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/StructureDefinition/UsageContext", "name": "UsageContext", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for UsageContext Type", "purpose": "Consumers of the resource must be able to determine the intended applicability for the resource. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "UsageContext", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "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" } ] }, { "id": "UsageContext.id", "path": "UsageContext.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "UsageContext.extension", "path": "UsageContext.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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" } } }, { "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" } } } ] }, "differential": { "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": "*" }, { "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" } } }, { "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/StructureDefinition/SimpleQuantity", "resource": { "resourceType": "StructureDefinition", "id": "SimpleQuantity", "meta": { "lastUpdated": "2017-04-19T07:44:43.294+10:00" }, "text": { "status": "generated", "div": "

Data type SimpleQuantity

A fixed quantity (no comparator)

Rule

The comparator is not used on a SimpleQuantity

XPath:

not(exists(f:comparator))
" }, "url": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity", "name": "SimpleQuantity", "status": "draft", "date": "2017-04-19T07:44:43+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "A fixed quantity (no comparator)", "fhirVersion": "3.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Quantity", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Quantity", "derivation": "constraint", "snapshot": { "element": [ { "id": "Quantity:simplequantity", "path": "Quantity", "sliceName": "SimpleQuantity", "short": "A fixed quantity (no comparator)", "definition": "The comparator is not used on a SimpleQuantity", "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": "*", "base": { "path": "Quantity", "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)", "source": "Quantity" }, { "key": "sqty-1", "severity": "error", "human": "The comparator is not used on a SimpleQuantity", "expression": "comparator.empty()", "xpath": "not(exists(f:comparator))" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL, MO, CO, depending on the values" } ] }, { "id": "Quantity:simplequantity.id", "path": "Quantity.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Quantity:simplequantity.extension", "path": "Quantity.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": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Quantity:simplequantity.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", "base": { "path": "Quantity.value", "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" } ] }, { "id": "Quantity:simplequantity.comparator", "path": "Quantity.comparator", "short": "< | <= | >= | > - how to understand the value", "definition": "Not allowed to be used in this context", "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": "0", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "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" } ] }, { "id": "Quantity:simplequantity.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", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "id": "Quantity:simplequantity.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", "base": { "path": "Quantity.system", "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" } ] }, { "id": "Quantity:simplequantity.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", "base": { "path": "Quantity.code", "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" } ] } ] }, "differential": { "element": [ { "id": "Quantity:simplequantity", "path": "Quantity", "sliceName": "SimpleQuantity", "short": "A fixed quantity (no comparator)", "definition": "The comparator is not used on a SimpleQuantity", "min": 0, "max": "*", "constraint": [ { "key": "sqty-1", "severity": "error", "human": "The comparator is not used on a SimpleQuantity", "expression": "comparator.empty()", "xpath": "not(exists(f:comparator))" } ], "isModifier": false }, { "id": "Quantity:simplequantity.comparator", "path": "Quantity.comparator", "definition": "Not allowed to be used in this context", "max": "0" } ] } } } ] }