| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| «A»N | Element | Base for elements defined inside a resource Elements defined in Ancestors: id, extension | ||
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| «A»N | Element | Base for elements defined inside a resource Elements defined in Ancestors: id, extension | ||
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ΣN | Element | An address expressed using postal conventions (as opposed to GPS or other location definition formats) Elements defined in Ancestors: id, extension | ||
| ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (Required) | |
| Σ | 0..1 | code | postal | physical | both Binding: AddressType (Required) | |
| Σ | 0..1 | string | Text representation of the address | |
| Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label | |
| Σ | 0..1 | string | Name of city, town etc. | |
| Σ | 0..1 | string | District name (aka county) | |
| Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | |
| Σ | 0..1 | string | Postal code for area | |
| Σ | 0..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) | |
| Σ | 0..1 | Period | Time period when address was/is in use | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ΣTU | Quantity | A duration of time during which an organism (or a process) has existed Binding: Common UCUM Codes for Age (Extensible)
+ Rule: 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 | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| N | Element | Text node with attribution Elements defined in Ancestors: id, extension | ||
| Σ | 0..1 | Individual responsible for the annotation | ||
| Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | ||||
| string | ||||
| Σ | 0..1 | dateTime | When the annotation was made | |
| Σ | 1..1 | markdown | The annotation - text content (as markdown) | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| N | Element | Content in a format defined elsewhere + Rule: If the Attachment has data, it SHALL have a contentType Elements defined in Ancestors: id, extension | ||||||
| ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (Required) | |||||
| Σ | 0..1 | code | Human language of the content (BCP-47) Binding: All Languages (Required)
| |||||
| C | 0..1 | base64Binary | Data inline, base64ed | |||||
| Σ | 0..1 | url | Uri where the data can be found | |||||
| Σ | 0..1 | integer64 | Number of bytes of content (if url provided) | |||||
| Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
| ΣT | 0..1 | string | Label to display in place of the data | |||||
| Σ | 0..1 | dateTime | Date attachment was first created | |||||
| TU | 0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
| TU | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
| TU | 0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
| TU | 0..1 | decimal | Length in seconds (audio / video) | |||||
| TU | 0..1 | positiveInt | Number of printed pages | |||||
\"].value"
}]
},
{
"id": "Attachment.width",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.width",
"short": "Width of the image in pixels (photo/video)",
"definition": "Width of the image in pixels (photo/video).",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.width",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id": "Attachment.frames",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.frames",
"short": "Number of frames if > 1 (photo)",
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"comment": "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.frames",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id": "Attachment.duration",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.duration",
"short": "Length in seconds (audio / video)",
"definition": "The duration of the recording in seconds - for audio and video.",
"comment": "The duration might differ from occurrencePeriod if recording was paused.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.duration",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id": "Attachment.pages",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.pages",
"short": "Number of printed pages",
"definition": "The number of pages when printed.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.pages",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false
}]
},
"differential": {
"element": [{
"id": "Attachment",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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 \"Signed Procedure Consent\".",
"min": 0,
"max": "*",
"constraint": [{
"key": "att-1",
"severity": "error",
"human": "If the Attachment has data, it SHALL have a contentType",
"expression": "data.empty() or contentType.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment"
}],
"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"
}],
"condition": ["att-1"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"
},
"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/tools/StructureDefinition/binding-definition",
"valueString": "IETF language tag for a human language."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "IETF language tag for a human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"additional": [{
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
}]
},
"mapping": [{
"identity": "rim",
"map": "./language"
}]
},
{
"id": "Attachment.data",
"path": "Attachment.data",
"short": "Data inline, base64ed",
"definition": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
"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"
}],
"condition": ["att-1"],
"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": "A 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": "url"
}],
"example": [{
"label": "General",
"valueUrl": "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": "integer64"
}],
"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. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.",
"requirements": "Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).",
"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
},
{
"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.",
"comment": "May sometimes be derived from the source filename.",
"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)"
}]
},
{
"id": "Attachment.height",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.height",
"short": "Height of the image in pixels (photo/video)",
"definition": "Height of the image in pixels (photo/video).",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}],
"mapping": [{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id": "Attachment.width",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.width",
"short": "Width of the image in pixels (photo/video)",
"definition": "Width of the image in pixels (photo/video).",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}],
"mapping": [{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id": "Attachment.frames",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.frames",
"short": "Number of frames if > 1 (photo)",
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"comment": "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}],
"mapping": [{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id": "Attachment.duration",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.duration",
"short": "Length in seconds (audio / video)",
"definition": "The duration of the recording in seconds - for audio and video.",
"comment": "The duration might differ from occurrencePeriod if recording was paused.",
"min": 0,
"max": "1",
"type": [{
"code": "decimal"
}],
"mapping": [{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id": "Attachment.pages",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Attachment.pages",
"short": "Number of printed pages",
"definition": "The number of pages when printed.",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Availability",
"resource": {
"resourceType": "StructureDefinition",
"id": "Availability",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints![\"doco\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\")
![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAwNdCABMPwMo2ctnoQAAAABJRU5ErkJggg==\")
![\".\"](\"data:image/png;base64,R0lGODlhEAAQAPQfAOvGUf7ztuvPMf/78/fkl/Pbg+u8Rvjqteu2Pf3zxPz36Pz0z+vTmPzurPvuw/npofbjquvNefHVduuyN+uuMu3Oafbgjfnqvf/3zv/3xevPi+vRjP/20/bmsP///wD/ACH5BAEKAB8ALAAAAAAQABAAAAVl4CeOZGme5qCqqDg8jyVJaz1876DsmAQAgqDgltspMEhMJoMZ4iy6I1AooFCIv+wKybziALVAoAEjYLwDgGIpJhMslgxaLR4/3rMAWoBp32V5exg8Shl1ckRUQVaMVkQ2kCstKCEAOw==\" "\\"Element\\"")
AvailabilityΣTU Element Availability data for an {item}
Elements defined in Ancestors: id, extension ![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC\")
availableTimeΣC 0..* Element Times the {item} is available
+ Rule: Cannot include start/end times when selecting all day availability.
![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3wYeFzMPbYccAgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAMElEQVQ4y+3OQREAIBDDwAv+PQcFFN5MIyCzqHMKUGVCpMFLK97heq+gggoq+EiwAVjvMhFGmlEUAAAAAElFTkSuQmCC\")
![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAARklEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4OvTRgwAAAABJRU5ErkJggg==\" "\\"Primitive")
daysOfWeekΣ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: Days Of Week (Required)
allDay ΣC 0..1 boolean Always available? i.e. 24 hour service
availableStartTime ΣC 0..1 time Opening time of day (ignored if allDay = true)
![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUOL+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC\")
availableEndTimeΣC 0..1 time Closing time of day (ignored if allDay = true)
notAvailableTime Σ 0..* Element Not available during this time due to provided reason
![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3wYeFzIZgEiYEgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAIElEQVQ4y2P8//8/AyWAiYFCMGrAqAGjBowaMGoAAgAALL0DKYQ0DPIAAAAASUVORK5CYII=\")
descriptionΣ 0..1 string Reason presented to the user explaining why time not available
![\".\"](\"data:image/png;base64,R0lGODlhEAAQAPZ/APrkusOiYvvfqbiXWaV2G+jGhdq1b8GgYf3v1frw3vTUlsWkZNewbcSjY/DQkad4Hb6dXv3u0f3v1ObEgfPTlerJiP3w1v79+e7OkPrfrfnjuNOtZPrpydaxa+/YrvvdpP779ZxvFPvnwKKBQaFyF/369M2vdaqHRPz58/HNh/vowufFhfroxO3OkPrluv779tK0e6JzGProwvrow9m4eOnIifPTlPDPkP78+Naxaf3v0/zowfXRi+bFhLWUVv379/rnwPvszv3rye3LiPvnv+3MjPDasKiIS/789/3x2f747eXDg+7Mifvu0tu7f+/QkfDTnPXWmPrjsvrjtPbPgrqZW+/QlPz48K2EMv36866OUPvowat8Ivvgq/Pbrvzgq/PguvrgrqN0Gda2evfYm9+7d/rpw9q6e/LSku/Rl/XVl/LSlfrkt+zVqe7Wqv3x1/bNffbOf59wFdS6if3u0vrqyP3owPvepfXQivDQkO/PkKh9K7STVf779P///wD/ACH5BAEKAH8ALAAAAAAQABAAAAemgH+CgxeFF4OIhBdKGwFChYl/hYwbdkoBPnaQkosbG3d3VEpSUlonUoY1Gzo6QkI8SrGxWBOFG4uySgY5ZWR3PFy2hnaWZXC/PHcPwkpJk1ShoHcxhQEXSUmtFy6+0iSFVResrjoTPDzdcoU+F65CduVU6KAhhQa3F8Tx8nchBoYuqoTLZoAKFRIhqGwqJAULFx0GYpBQeChRIR4TJm6KJMhQRUSBAAA7\" "\\"Data")
duringΣ 0..1 Period Service not available during this period
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Availability",
"version": "5.0.0",
"name": "Availability",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Availability Type: Availability data for an {item}.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Availability",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Availability",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Availability",
"short": "Availability data for an {item}",
"definition": "Availability data for an {item}.",
"min": 0,
"max": "*",
"base": {
"path": "Availability",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Availability.id",
"path": "Availability.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Availability.extension",
"path": "Availability.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Availability.availableTime",
"path": "Availability.availableTime",
"short": "Times the {item} is available",
"definition": "Times the {item} is available.",
"requirements": "A collection of times that the {item} is available.",
"min": 0,
"max": "*",
"base": {
"path": "Availability.availableTime",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "av-1",
"severity": "error",
"human": "Cannot include start/end times when selecting all day availability.",
"expression": "allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not())",
"source": "http://hl7.org/fhir/StructureDefinition/Availability"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Availability.availableTime.id",
"path": "Availability.availableTime.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Availability.availableTime.extension",
"path": "Availability.availableTime.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Availability.availableTime.daysOfWeek",
"path": "Availability.availableTime.daysOfWeek",
"short": "mon | tue | wed | thu | fri | sat | sun",
"definition": "mon | tue | wed | thu | fri | sat | sun.",
"requirements": "Indicates which days of the week are available between the start and end Times.",
"min": 0,
"max": "*",
"base": {
"path": "Availability.availableTime.daysOfWeek",
"min": 0,
"max": "*"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DaysOfWeek"
}],
"strength": "required",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|5.0.0"
}
},
{
"id": "Availability.availableTime.allDay",
"path": "Availability.availableTime.allDay",
"short": "Always available? i.e. 24 hour service",
"definition": "Always available? i.e. 24 hour service.",
"requirements": "Is this always available? (hence times are irrelevant) i.e. 24 hour service.",
"min": 0,
"max": "1",
"base": {
"path": "Availability.availableTime.allDay",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"condition": ["av-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Availability.availableTime.availableStartTime",
"path": "Availability.availableTime.availableStartTime",
"short": "Opening time of day (ignored if allDay = true)",
"definition": "Opening time of day (ignored if allDay = true).",
"comment": "The timezone is expected to be specified or implied by the context this datatype is used.",
"requirements": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"min": 0,
"max": "1",
"base": {
"path": "Availability.availableTime.availableStartTime",
"min": 0,
"max": "1"
},
"type": [{
"code": "time"
}],
"condition": ["av-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Availability.availableTime.availableEndTime",
"path": "Availability.availableTime.availableEndTime",
"short": "Closing time of day (ignored if allDay = true)",
"definition": "Closing time of day (ignored if allDay = true).",
"comment": "The timezone is expected to be specified or implied by the context this datatype is used.",
"requirements": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"min": 0,
"max": "1",
"base": {
"path": "Availability.availableTime.availableEndTime",
"min": 0,
"max": "1"
},
"type": [{
"code": "time"
}],
"condition": ["av-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Availability.notAvailableTime",
"path": "Availability.notAvailableTime",
"short": "Not available during this time due to provided reason",
"definition": "Not available during this time due to provided reason.",
"requirements": "The {item} is not available during this period of time due to the provided reason.",
"min": 0,
"max": "*",
"base": {
"path": "Availability.notAvailableTime",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Availability.notAvailableTime.id",
"path": "Availability.notAvailableTime.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Availability.notAvailableTime.extension",
"path": "Availability.notAvailableTime.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Availability.notAvailableTime.description",
"path": "Availability.notAvailableTime.description",
"short": "Reason presented to the user explaining why time not available",
"definition": "Reason presented to the user explaining why time not available.",
"comment": "The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the `during` might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year).\n\ne.g.2: 'Closed for maintenance over the summer' for this example you would want to include the `during` period, unless this was a university hospital and the \"summer\" period was well known, but would recommend its inclusion anyway.",
"requirements": "The reason that can be presented to the user as to why this time is not available.",
"min": 0,
"max": "1",
"base": {
"path": "Availability.notAvailableTime.description",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Availability.notAvailableTime.during",
"path": "Availability.notAvailableTime.during",
"short": "Service not available during this period",
"definition": "Service not available during this period.",
"requirements": "The {item} is not available (seasonally or for a public holiday) during this period.",
"min": 0,
"max": "1",
"base": {
"path": "Availability.notAvailableTime.during",
"min": 0,
"max": "1"
},
"type": [{
"code": "Period"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "Availability",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Availability",
"short": "Availability data for an {item}",
"definition": "Availability data for an {item}.",
"min": 0,
"max": "*"
},
{
"id": "Availability.availableTime",
"path": "Availability.availableTime",
"short": "Times the {item} is available",
"definition": "Times the {item} is available.",
"requirements": "A collection of times that the {item} is available.",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "av-1",
"severity": "error",
"human": "Cannot include start/end times when selecting all day availability.",
"expression": "allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not())",
"source": "http://hl7.org/fhir/StructureDefinition/Availability"
}],
"isSummary": true
},
{
"id": "Availability.availableTime.daysOfWeek",
"path": "Availability.availableTime.daysOfWeek",
"short": "mon | tue | wed | thu | fri | sat | sun",
"definition": "mon | tue | wed | thu | fri | sat | sun.",
"requirements": "Indicates which days of the week are available between the start and end Times.",
"min": 0,
"max": "*",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DaysOfWeek"
}],
"strength": "required",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|5.0.0"
}
},
{
"id": "Availability.availableTime.allDay",
"path": "Availability.availableTime.allDay",
"short": "Always available? i.e. 24 hour service",
"definition": "Always available? i.e. 24 hour service.",
"requirements": "Is this always available? (hence times are irrelevant) i.e. 24 hour service.",
"min": 0,
"max": "1",
"type": [{
"code": "boolean"
}],
"condition": ["av-1"],
"isSummary": true
},
{
"id": "Availability.availableTime.availableStartTime",
"path": "Availability.availableTime.availableStartTime",
"short": "Opening time of day (ignored if allDay = true)",
"definition": "Opening time of day (ignored if allDay = true).",
"comment": "The timezone is expected to be specified or implied by the context this datatype is used.",
"requirements": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"min": 0,
"max": "1",
"type": [{
"code": "time"
}],
"condition": ["av-1"],
"isSummary": true
},
{
"id": "Availability.availableTime.availableEndTime",
"path": "Availability.availableTime.availableEndTime",
"short": "Closing time of day (ignored if allDay = true)",
"definition": "Closing time of day (ignored if allDay = true).",
"comment": "The timezone is expected to be specified or implied by the context this datatype is used.",
"requirements": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"min": 0,
"max": "1",
"type": [{
"code": "time"
}],
"condition": ["av-1"],
"isSummary": true
},
{
"id": "Availability.notAvailableTime",
"path": "Availability.notAvailableTime",
"short": "Not available during this time due to provided reason",
"definition": "Not available during this time due to provided reason.",
"requirements": "The {item} is not available during this period of time due to the provided reason.",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"isSummary": true
},
{
"id": "Availability.notAvailableTime.description",
"path": "Availability.notAvailableTime.description",
"short": "Reason presented to the user explaining why time not available",
"definition": "Reason presented to the user explaining why time not available.",
"comment": "The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the `during` might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year).\n\ne.g.2: 'Closed for maintenance over the summer' for this example you would want to include the `during` period, unless this was a university hospital and the \"summer\" period was well known, but would recommend its inclusion anyway.",
"requirements": "The reason that can be presented to the user as to why this time is not available.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
},
{
"id": "Availability.notAvailableTime.during",
"path": "Availability.notAvailableTime.during",
"short": "Service not available during this period",
"definition": "Service not available during this period.",
"requirements": "The {item} is not available (seasonally or for a public holiday) during this period.",
"min": 0,
"max": "1",
"type": [{
"code": "Period"
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/BackboneType",
"resource": {
"resourceType": "StructureDefinition",
"id": "BackboneType",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints BackboneType «A»N Element Base for datatypes that can carry modifier extensions
Elements defined in Ancestors: id, extension ![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAADdSURBVDjLY/j//z8DJZhhmBvw41KQ07dzbk5kG/Dtgu/Jb2fsT5JkwI+bqZw/rsfYA21v+XE97f+PS5H/vx5Ra/98QN7+824ZTiIMSJr580bW/x+3iv//etD9/+fdpv/fzwX+/3LY6P/n7TIzCRtwPYYZaPvGH7dKgAb0AA1o/v/tQsh/oO0bP26TZiYqDIB+1/1+wef/z3vN/3/erPr/5aAOyHZdogMRGPIe38/7gvz+Gej3z18OG/8H2u5BvAFn7GO/Htdv/3pAQejzXjkhoO3tH7dIxY7EpEwMBgAr6O5Q8udliwAAAABJRU5ErkJggg==\" "\\"Extension\\"")
modifierExtension?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/BackboneType",
"version": "5.0.0",
"name": "BackboneType",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "BackboneType Type: Base definition for the few data types that are allowed to carry modifier extensions.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": true,
"type": "BackboneType",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "BackboneType",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "BackboneType",
"short": "Base for datatypes that can carry modifier extensions",
"definition": "Base definition for the few data types that are allowed to carry modifier extensions.",
"min": 0,
"max": "*",
"base": {
"path": "BackboneType",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "BackboneType.id",
"path": "BackboneType.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "BackboneType.extension",
"path": "BackboneType.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "BackboneType.modifierExtension",
"path": "BackboneType.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": ["extensions",
"user content",
"modifiers"],
"min": 0,
"max": "*",
"base": {
"path": "BackboneType.modifierExtension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
},
"differential": {
"element": [{
"id": "BackboneType",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "BackboneType",
"short": "Base for datatypes that can carry modifier extensions",
"definition": "Base definition for the few data types that are allowed to carry modifier extensions.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "BackboneType.modifierExtension",
"path": "BackboneType.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": ["extensions",
"user content",
"modifiers"],
"min": 0,
"max": "*",
"type": [{
"code": "Extension"
}],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Base",
"resource": {
"resourceType": "StructureDefinition",
"id": "Base",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints ![\".\"](\"data:image/png;base64,R0lGODlhEAAQAMQfAGm6/idTd4yTmF+v8Xa37KvW+lyh3KHJ62aq41ee2bXZ98nm/2mt5W2Ck5XN/C1chEZieho8WXXA/2Gn4P39/W+y6V+l3qjP8Njt/lx2izxPYGyv51Oa1EJWZ////////yH5BAEAAB8ALAAAAAAQABAAAAWH4Cd+Xml6Y0pCQts0EKp6GbYshaM/skhjhCChUmFIeL4OsHIxXRAISQTl6SgIG8+FgfBMoh2qtbLZQr0TQJhk3TC4pYPBApiyFVDEwSOf18UFXxMWBoUJBn9sDgmDewcJCRyJJBoEkRyYmAABPZQEAAOhA5seFDMaDw8BAQ9TpiokJyWwtLUhADs=\" "\\"Choice")
Base«A»N Base for all types and resources
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Base",
"version": "5.0.0",
"name": "Base",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Base Type: Base definition for all types defined in FHIR type system.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": true,
"type": "Base",
"snapshot": {
"element": [{
"id": "Base",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Base",
"short": "Base for all types and resources",
"definition": "Base definition for all types defined in FHIR type system.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
}]
},
"differential": {
"element": [{
"id": "Base",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Base",
"short": "Base for all types and resources",
"definition": "Base definition for all types defined in FHIR type system.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/CodeableConcept",
"resource": {
"resourceType": "StructureDefinition",
"id": "CodeableConcept",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints CodeableConcept ΣN Element Concept - reference to a terminology or just text
Elements defined in Ancestors: id, extension coding Σ 0..* Coding Code defined by a terminology system
text ΣT 0..1 string Plain text representation of the concept
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "do-translations"
}],
"url": "http://hl7.org/fhir/StructureDefinition/CodeableConcept",
"version": "5.0.0",
"name": "CodeableConcept",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"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": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "CodeableConcept",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"base": {
"path": "CodeableConcept",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,CD"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}]
},
{
"id": "CodeableConcept.id",
"path": "CodeableConcept.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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 alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}]
},
{
"id": "CodeableConcept.text",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}]
}]
},
"differential": {
"element": [{
"id": "CodeableConcept",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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 alternative encodings within a code system, and translations to other code systems.",
"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
},
{
"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/CodeableReference",
"resource": {
"resourceType": "StructureDefinition",
"id": "CodeableReference",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints CodeableReference ΣD Element Reference to a resource or a concept
Elements defined in Ancestors: id, extension concept Σ 0..1 CodeableConcept Reference to a concept (by class)
![\".\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAadEVYdFNvZnR3YXJlAFBhaW50Lk5FVCB2My41LjEwMPRyoQAAAFxJREFUOE/NjEEOACEIA/0o/38GGw+agoXYeNnDJDCUDnd/gkoFKhWozJiZI3gLwY6rAgxhsPKTPUzycTl8lAryMyMsVQG6TFi6cHULyz8KOjC7OIQKlQpU3uPjAwhX2CCcGsgOAAAAAElFTkSuQmCC\" "\\"Reference")
referenceΣ 0..1 Reference() Reference to a resource (by instance)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-target"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "do-translations"
}],
"url": "http://hl7.org/fhir/StructureDefinition/CodeableReference",
"version": "5.0.0",
"name": "CodeableReference",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "CodeableReference Type: A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "This is a common pattern in record keeping - a reference may be made to a specific condition, observation, plan, or definition, or a reference may be made to a general concept defined in a knowledge base somewhere.",
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "CodeableReference",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "CodeableReference",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"path": "CodeableReference",
"short": "Reference to a resource or a concept",
"definition": "A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).",
"min": 0,
"max": "*",
"base": {
"path": "CodeableReference",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "CodeableReference.id",
"path": "CodeableReference.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "CodeableReference.extension",
"path": "CodeableReference.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "CodeableReference.concept",
"path": "CodeableReference.concept",
"short": "Reference to a concept (by class)",
"definition": "A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableReference.concept",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "CodeableReference.reference",
"path": "CodeableReference.reference",
"short": "Reference to a resource (by instance)",
"definition": "A reference to a resource the provides exact details about the information being referenced.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableReference.reference",
"min": 0,
"max": "1"
},
"type": [{
"code": "Reference"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
},
"differential": {
"element": [{
"id": "CodeableReference",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"path": "CodeableReference",
"short": "Reference to a resource or a concept",
"definition": "A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).",
"min": 0,
"max": "*"
},
{
"id": "CodeableReference.concept",
"path": "CodeableReference.concept",
"short": "Reference to a concept (by class)",
"definition": "A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "CodeableReference.reference",
"path": "CodeableReference.reference",
"short": "Reference to a resource (by instance)",
"definition": "A reference to a resource the provides exact details about the information being referenced.",
"min": 0,
"max": "1",
"type": [{
"code": "Reference"
}],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Coding",
"resource": {
"resourceType": "StructureDefinition",
"id": "Coding",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Coding ΣN Element A reference to a code defined by a terminology system
+ Warning: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
Elements defined in Ancestors: id, extension system Σ 0..1 uri Identity of the terminology system
version Σ 0..1 string Version of the system - if relevant
code ΣC 0..1 code Symbol in syntax defined by the system
display ΣTC 0..1 string Representation defined by the system
userSelected Σ 0..1 boolean If this coding was chosen directly by the user
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "do-translations"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Coding",
"version": "5.0.0",
"name": "Coding",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Coding Type: A reference to a code defined by a terminology system.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "References to codes are very common in healthcare models.",
"fhirVersion": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Coding",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"base": {
"path": "Coding",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "cod-1",
"severity": "warning",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"expression": "code.exists().not() implies display.exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/Coding"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,CV"
},
{
"identity": "v2",
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity": "orim",
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding"
}]
},
{
"id": "Coding.id",
"path": "Coding.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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 be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
},
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}]
},
{
"id": "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",
"base": {
"path": "Coding.version",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
},
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}]
},
{
"id": "Coding.code",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["cod-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
},
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}]
},
{
"id": "Coding.display",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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",
"base": {
"path": "Coding.display",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["cod-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
},
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}]
},
{
"id": "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 - e.g. off a pick list of available items (codes or displays).",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.userSelected",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
},
{
"identity": "orim",
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}]
}]
},
"differential": {
"element": [{
"id": "Coding",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"constraint": [{
"key": "cod-1",
"severity": "warning",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"expression": "code.exists().not() implies display.exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/Coding"
}],
"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 be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 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",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["cod-1"],
"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
},
{
"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"
}],
"condition": ["cod-1"],
"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 - e.g. off a pick list of available items (codes or displays).",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"max": "1",
"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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints ContactDetail ΣN Element Contact information
Elements defined in Ancestors: id, extension name Σ 0..1 string Name of an individual to contact
telecom Σ 0..* ContactPoint Contact details for individual or organization
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/ContactDetail",
"version": "5.0.0",
"name": "ContactDetail",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "ContactDetail Type: Specifies contact information for a person or organization.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to track contact information in the same way across multiple resources.",
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "ContactDetail",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "ContactDetail",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "ContactDetail",
"short": "Contact information",
"definition": "Specifies contact information for a person or organization.",
"min": 0,
"max": "*",
"base": {
"path": "ContactDetail",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ContactDetail.id",
"path": "ContactDetail.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "ContactDetail.name",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "*",
"base": {
"path": "ContactDetail.telecom",
"min": 0,
"max": "*"
},
"type": [{
"code": "ContactPoint"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "ContactDetail",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints ContactPoint ΣN Element Details of a Technology mediated contact point (phone, fax, email, etc.)
+ Rule: A system is required if a value is provided.
Elements defined in Ancestors: id, extension system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (Required)
value ΣC 0..1 string The actual contact point details
use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (Required)
rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
period Σ 0..1 Period Time period when the contact point was/is in use
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
"version": "5.0.0",
"name": "ContactPoint",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc.",
"fhirVersion": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "ContactPoint",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"base": {
"path": "ContactPoint",
"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()",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,TEL"
},
{
"identity": "v2",
"map": "XTN"
},
{
"identity": "servd",
"map": "ContactPoint"
}]
},
{
"id": "ContactPoint.id",
"path": "ContactPoint.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "ContactPoint.system",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["cpt-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Telecommunications form for contact point."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
}],
"strength": "required",
"description": "Telecommunications form for contact point.",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0"
},
"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",
"base": {
"path": "ContactPoint.value",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["cpt-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "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",
"base": {
"path": "ContactPoint.use",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Use of contact point."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
}],
"strength": "required",
"description": "Use of contact point.",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0"
},
"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. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.\n\nRanks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean \"X is my most preferred phone number, Y is my most preferred email address\" or \"X is my preferred home email and Y is my preferred work email\". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. \n\nRanks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.rank",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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",
"base": {
"path": "ContactPoint.period",
"min": 0,
"max": "1"
},
"type": [{
"code": "Period"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}]
}]
},
"differential": {
"element": [{
"id": "ContactPoint",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint"
}],
"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/tools/StructureDefinition/binding-definition",
"valueString": "Telecommunications form for contact point."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
}],
"strength": "required",
"description": "Telecommunications form for contact point.",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0"
},
"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"
}],
"condition": ["cpt-2"],
"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": "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,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Use of contact point."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
}],
"strength": "required",
"description": "Use of contact point.",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0"
},
"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. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.\n\nRanks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean \"X is my most preferred phone number, Y is my most preferred email address\" or \"X is my preferred home email and Y is my preferred work email\". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. \n\nRanks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.",
"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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Contributor ΣTU Element Contributor information
Elements defined in Ancestors: id, extension type Σ 1..1 code author | editor | reviewer | endorser
Binding: ContributorType (Required)
name Σ 1..1 string Who contributed the content
contact Σ 0..* ContactDetail Contact details of the contributor
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Contributor",
"version": "5.0.0",
"name": "Contributor",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to track contributor information in the same way across multiple resources.",
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Contributor",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Contributor",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Contributor",
"short": "Contributor information",
"definition": "A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.",
"min": 0,
"max": "*",
"base": {
"path": "Contributor",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Contributor.id",
"path": "Contributor.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Contributor.type",
"path": "Contributor.type",
"short": "author | editor | reviewer | endorser",
"definition": "The type of contributor.",
"min": 1,
"max": "1",
"base": {
"path": "Contributor.type",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The type of contributor."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContributorType"
}],
"strength": "required",
"description": "The type of contributor.",
"valueSet": "http://hl7.org/fhir/ValueSet/contributor-type|5.0.0"
}
},
{
"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",
"base": {
"path": "Contributor.name",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "*",
"base": {
"path": "Contributor.contact",
"min": 0,
"max": "*"
},
"type": [{
"code": "ContactDetail"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "Contributor",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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/tools/StructureDefinition/binding-definition",
"valueString": "The type of contributor."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContributorType"
}],
"strength": "required",
"description": "The type of contributor.",
"valueSet": "http://hl7.org/fhir/ValueSet/contributor-type|5.0.0"
}
},
{
"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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Count ΣTU Quantity A measured or measurable amount
+ Rule: There SHALL be a code with a value of "1" if there is a value. If system is present, it SHALL be UCUM. If present, the value SHALL be a whole number.
Elements defined in Ancestors: id, extension, value, comparator, unit, system, code
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Count",
"version": "5.0.0",
"name": "Count",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Count Type: 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.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"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": "5.0.0",
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "Count",
"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. If system is present, it SHALL be UCUM. If present, the value SHALL be a whole number.",
"expression": "(code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())",
"source": "http://hl7.org/fhir/StructureDefinition/Count"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}],
"isModifier": false,
"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": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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": "< | <= | >= | > | ad - how to understand the value",
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.comparator",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How the Quantity should be understood and represented."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}]
},
{
"id": "Count.unit",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(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"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "CO.codeSystem, PQ.translation.codeSystem"
}]
},
{
"id": "Count.code",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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. If system is present, it SHALL be UCUM. If present, the value SHALL be a whole number.",
"expression": "(code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())",
"source": "http://hl7.org/fhir/StructureDefinition/Count"
}],
"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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints DataRequirement ΣTU Element Describes a required data item
Elements defined in Ancestors: id, extension type Σ 1..1 code The type of the required data
Binding: All FHIR Types (Required)
profile Σ 0..* canonical(StructureDefinition) The profile of the required data
subject[x] Σ 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Participant Resource Types (Extensible)
subjectCodeableConcept CodeableConcept subjectReference Reference(Group) mustSupport Σ 0..* string Indicates specific structure elements that are referenced by the knowledge module
codeFilter ΣC 0..* Element What codes are expected
+ Rule: Either a path or a searchParam must be provided, but not both
path ΣC 0..1 string A code-valued attribute to filter on
searchParam ΣC 0..1 string A coded (token) parameter to search on
valueSet Σ 0..1 canonical(ValueSet) ValueSet for the filter
code Σ 0..* Coding What code is expected
dateFilter ΣC 0..* Element What dates/date ranges are expected
+ Rule: Either a path or a searchParam must be provided, but not both
path ΣC 0..1 string A date-valued attribute to filter on
searchParam ΣC 0..1 string A date valued parameter to search on
value[x] Σ 0..1 The value of the filter, as a Period, DateTime, or Duration value
valueDateTime dateTime valuePeriod Period valueDuration Duration valueFilter Σ 0..* Element What values are expected
path Σ 0..1 string An attribute to filter on
searchParam Σ 0..1 string A parameter to search on
comparator Σ 0..1 code eq | gt | lt | ge | le | sa | eb
Binding: Value Filter Comparator (Required)
value[x] Σ 0..1 The value of the filter, as a Period, DateTime, or Duration value
valueDateTime dateTime valuePeriod Period valueDuration Duration limit Σ 0..1 positiveInt Number of results
sort Σ 0..* Element Order of the results
path Σ 1..1 string The name of the attribute to perform the sort
direction Σ 1..1 code ascending | descending
Binding: SortDirection (Required)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/DataRequirement",
"version": "5.0.0",
"name": "DataRequirement",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "DataRequirement",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "DataRequirement",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "DataRequirement",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataRequirement.id",
"path": "DataRequirement.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "DataRequirement.type",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "List of FHIR types (resources, data types)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "List of FHIR types (resources, data types).",
"valueSet": "http://hl7.org/fhir/ValueSet/fhir-types|5.0.0"
}
},
{
"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": "*",
"base": {
"path": "DataRequirement.profile",
"min": 0,
"max": "*"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.subject[x]",
"path": "DataRequirement.subject[x]",
"short": "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device",
"definition": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.",
"comment": "The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.subject[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing": "Patient",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubjectType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "extensible",
"description": "The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).",
"valueSet": "http://hl7.org/fhir/ValueSet/participant-resource-types"
}
},
{
"id": "DataRequirement.mustSupport",
"path": "DataRequirement.mustSupport",
"short": "Indicates specific structure elements that 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. \n\nThe value of mustSupport SHALL be a FHIRPath resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"min": 0,
"max": "*",
"base": {
"path": "DataRequirement.mustSupport",
"min": 0,
"max": "*"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.",
"min": 0,
"max": "*",
"base": {
"path": "DataRequirement.codeFilter",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "drq-1",
"severity": "error",
"human": "Either a path or a searchParam must be provided, but not both",
"expression": "path.exists() xor searchParam.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/DataRequirement"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.id",
"path": "DataRequirement.codeFilter.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataRequirement.codeFilter.path",
"path": "DataRequirement.codeFilter.path",
"short": "A code-valued attribute to filter on",
"definition": "The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.",
"comment": "The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.codeFilter.path",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["drq-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.searchParam",
"path": "DataRequirement.codeFilter.searchParam",
"short": "A coded (token) parameter to search on",
"definition": "A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.codeFilter.searchParam",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["drq-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.valueSet",
"path": "DataRequirement.codeFilter.valueSet",
"short": "ValueSet for the filter",
"definition": "The valueset for the code filter. The valueSet and code elements are additive. 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",
"base": {
"path": "DataRequirement.codeFilter.valueSet",
"min": 0,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.code",
"path": "DataRequirement.codeFilter.code",
"short": "What code is expected",
"definition": "The codes for the code filter. 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. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.",
"min": 0,
"max": "*",
"base": {
"path": "DataRequirement.codeFilter.code",
"min": 0,
"max": "*"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"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. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.",
"min": 0,
"max": "*",
"base": {
"path": "DataRequirement.dateFilter",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "drq-2",
"severity": "error",
"human": "Either a path or a searchParam must be provided, but not both",
"expression": "path.exists() xor searchParam.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/DataRequirement"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.dateFilter.id",
"path": "DataRequirement.dateFilter.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataRequirement.dateFilter.path",
"path": "DataRequirement.dateFilter.path",
"short": "A date-valued attribute to filter on",
"definition": "The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.",
"comment": "The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.dateFilter.path",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["drq-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.dateFilter.searchParam",
"path": "DataRequirement.dateFilter.searchParam",
"short": "A date valued parameter to search on",
"definition": "A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.dateFilter.searchParam",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["drq-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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 before now.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.dateFilter.value[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.valueFilter",
"path": "DataRequirement.valueFilter",
"short": "What values are expected",
"definition": "Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).",
"min": 0,
"max": "*",
"base": {
"path": "DataRequirement.valueFilter",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.valueFilter.id",
"path": "DataRequirement.valueFilter.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataRequirement.valueFilter.extension",
"path": "DataRequirement.valueFilter.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataRequirement.valueFilter.path",
"path": "DataRequirement.valueFilter.path",
"short": "An attribute to filter on",
"definition": "The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.",
"comment": "The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.valueFilter.path",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.valueFilter.searchParam",
"path": "DataRequirement.valueFilter.searchParam",
"short": "A parameter to search on",
"definition": "A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.valueFilter.searchParam",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.valueFilter.comparator",
"path": "DataRequirement.valueFilter.comparator",
"short": "eq | gt | lt | ge | le | sa | eb",
"definition": "The comparator to be used to determine whether the value is matching.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.valueFilter.comparator",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Possible comparators for the valueFilter element."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ValueFilterComparator"
}],
"strength": "required",
"description": "Possible comparators for the valueFilter element.",
"valueSet": "http://hl7.org/fhir/ValueSet/value-filter-comparator|5.0.0"
}
},
{
"id": "DataRequirement.valueFilter.value[x]",
"path": "DataRequirement.valueFilter.value[x]",
"short": "The value of the filter, as a Period, DateTime, or Duration value",
"definition": "The value of the filter.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.valueFilter.value[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.limit",
"path": "DataRequirement.limit",
"short": "Number of results",
"definition": "Specifies a maximum number of results that are required (uses the _count search parameter).",
"comment": "This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\".",
"requirements": "Enables the requirement \"most recent 5 results\" to be expressed.",
"min": 0,
"max": "1",
"base": {
"path": "DataRequirement.limit",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.sort",
"path": "DataRequirement.sort",
"short": "Order of the results",
"definition": "Specifies the order of the results to be returned.",
"comment": "This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\". When multiple sorts are specified, they are applied in the order they appear in the resource.",
"requirements": "Enables the requirement \"most recent 5 results\" to be expressed.",
"min": 0,
"max": "*",
"base": {
"path": "DataRequirement.sort",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.sort.id",
"path": "DataRequirement.sort.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataRequirement.sort.extension",
"path": "DataRequirement.sort.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataRequirement.sort.path",
"path": "DataRequirement.sort.path",
"short": "The name of the attribute to perform the sort",
"definition": "The attribute of the sort. 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.",
"min": 1,
"max": "1",
"base": {
"path": "DataRequirement.sort.path",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "DataRequirement.sort.direction",
"path": "DataRequirement.sort.direction",
"short": "ascending | descending",
"definition": "The direction of the sort, ascending or descending.",
"min": 1,
"max": "1",
"base": {
"path": "DataRequirement.sort.direction",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The possible sort directions, ascending or descending."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SortDirection"
}],
"strength": "required",
"description": "The possible sort directions, ascending or descending.",
"valueSet": "http://hl7.org/fhir/ValueSet/sort-direction|5.0.0"
}
}]
},
"differential": {
"element": [{
"id": "DataRequirement",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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/tools/StructureDefinition/binding-definition",
"valueString": "List of FHIR types (resources, data types)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "List of FHIR types (resources, data types).",
"valueSet": "http://hl7.org/fhir/ValueSet/fhir-types|5.0.0"
}
},
{
"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": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary": true
},
{
"id": "DataRequirement.subject[x]",
"path": "DataRequirement.subject[x]",
"short": "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device",
"definition": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.",
"comment": "The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing": "Patient",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubjectType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "extensible",
"description": "The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).",
"valueSet": "http://hl7.org/fhir/ValueSet/participant-resource-types"
}
},
{
"id": "DataRequirement.mustSupport",
"path": "DataRequirement.mustSupport",
"short": "Indicates specific structure elements that 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. \n\nThe value of mustSupport SHALL be a FHIRPath resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"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. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "drq-1",
"severity": "error",
"human": "Either a path or a searchParam must be provided, but not both",
"expression": "path.exists() xor searchParam.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/DataRequirement"
}],
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.path",
"path": "DataRequirement.codeFilter.path",
"short": "A code-valued attribute to filter on",
"definition": "The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.",
"comment": "The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["drq-1"],
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.searchParam",
"path": "DataRequirement.codeFilter.searchParam",
"short": "A coded (token) parameter to search on",
"definition": "A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["drq-1"],
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.valueSet",
"path": "DataRequirement.codeFilter.valueSet",
"short": "ValueSet for the filter",
"definition": "The valueset for the code filter. The valueSet and code elements are additive. 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": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"isSummary": true
},
{
"id": "DataRequirement.codeFilter.code",
"path": "DataRequirement.codeFilter.code",
"short": "What code is expected",
"definition": "The codes for the code filter. 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. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.",
"min": 0,
"max": "*",
"type": [{
"code": "Coding"
}],
"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. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "drq-2",
"severity": "error",
"human": "Either a path or a searchParam must be provided, but not both",
"expression": "path.exists() xor searchParam.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/DataRequirement"
}],
"isSummary": true
},
{
"id": "DataRequirement.dateFilter.path",
"path": "DataRequirement.dateFilter.path",
"short": "A date-valued attribute to filter on",
"definition": "The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.",
"comment": "The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["drq-2"],
"isSummary": true
},
{
"id": "DataRequirement.dateFilter.searchParam",
"path": "DataRequirement.dateFilter.searchParam",
"short": "A date valued parameter to search on",
"definition": "A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["drq-2"],
"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 before now.",
"min": 0,
"max": "1",
"type": [{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
}],
"isSummary": true
},
{
"id": "DataRequirement.valueFilter",
"path": "DataRequirement.valueFilter",
"short": "What values are expected",
"definition": "Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"isSummary": true
},
{
"id": "DataRequirement.valueFilter.path",
"path": "DataRequirement.valueFilter.path",
"short": "An attribute to filter on",
"definition": "The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.",
"comment": "The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
},
{
"id": "DataRequirement.valueFilter.searchParam",
"path": "DataRequirement.valueFilter.searchParam",
"short": "A parameter to search on",
"definition": "A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
},
{
"id": "DataRequirement.valueFilter.comparator",
"path": "DataRequirement.valueFilter.comparator",
"short": "eq | gt | lt | ge | le | sa | eb",
"definition": "The comparator to be used to determine whether the value is matching.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Possible comparators for the valueFilter element."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ValueFilterComparator"
}],
"strength": "required",
"description": "Possible comparators for the valueFilter element.",
"valueSet": "http://hl7.org/fhir/ValueSet/value-filter-comparator|5.0.0"
}
},
{
"id": "DataRequirement.valueFilter.value[x]",
"path": "DataRequirement.valueFilter.value[x]",
"short": "The value of the filter, as a Period, DateTime, or Duration value",
"definition": "The value of the filter.",
"min": 0,
"max": "1",
"type": [{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
}],
"isSummary": true
},
{
"id": "DataRequirement.limit",
"path": "DataRequirement.limit",
"short": "Number of results",
"definition": "Specifies a maximum number of results that are required (uses the _count search parameter).",
"comment": "This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\".",
"requirements": "Enables the requirement \"most recent 5 results\" to be expressed.",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}],
"isSummary": true
},
{
"id": "DataRequirement.sort",
"path": "DataRequirement.sort",
"short": "Order of the results",
"definition": "Specifies the order of the results to be returned.",
"comment": "This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\". When multiple sorts are specified, they are applied in the order they appear in the resource.",
"requirements": "Enables the requirement \"most recent 5 results\" to be expressed.",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"isSummary": true
},
{
"id": "DataRequirement.sort.path",
"path": "DataRequirement.sort.path",
"short": "The name of the attribute to perform the sort",
"definition": "The attribute of the sort. 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.",
"min": 1,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
},
{
"id": "DataRequirement.sort.direction",
"path": "DataRequirement.sort.direction",
"short": "ascending | descending",
"definition": "The direction of the sort, ascending or descending.",
"min": 1,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The possible sort directions, ascending or descending."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SortDirection"
}],
"strength": "required",
"description": "The possible sort directions, ascending or descending.",
"valueSet": "http://hl7.org/fhir/ValueSet/sort-direction|5.0.0"
}
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/DataType",
"resource": {
"resourceType": "StructureDefinition",
"id": "DataType",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints DataType «A»N Element Reuseable Types
Elements defined in Ancestors: id, extension
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/DataType",
"version": "5.0.0",
"name": "DataType",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "DataType Type: The base class for all re-useable types defined as part of the FHIR Specification.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": true,
"type": "DataType",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "DataType",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "DataType",
"short": "Reuseable Types",
"definition": "The base class for all re-useable types defined as part of the FHIR Specification.",
"min": 0,
"max": "*",
"base": {
"path": "DataType",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataType.id",
"path": "DataType.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "DataType.extension",
"path": "DataType.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
}]
},
"differential": {
"element": [{
"id": "DataType",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "DataType",
"short": "Reuseable Types",
"definition": "The base class for all re-useable types defined as part of the FHIR Specification.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Distance",
"resource": {
"resourceType": "StructureDefinition",
"id": "Distance",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Distance ΣTU Quantity A length - a value with a unit that is a physical distance
Binding: Common UCUM Codes for Distance (Extensible)Additional Bindings Purpose All UCUM Expression for Distance Max Binding
+ Rule: 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
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Distance",
"version": "5.0.0",
"name": "Distance",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Distance Type: A length - a value with a unit that is a physical distance.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "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.exists() or value.empty()) and (system.empty() or system = %ucum)",
"source": "http://hl7.org/fhir/StructureDefinition/Distance"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}],
"isModifier": false,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Appropriate units for Distance."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DistanceUnits"
}],
"strength": "extensible",
"description": "Appropriate units for Distance.",
"valueSet": "http://hl7.org/fhir/ValueSet/distance-units",
"additional": [{
"purpose": "maximum",
"valueSet": "http://hl7.org/fhir/ValueSet/all-distance-units"
}]
},
"mapping": [{
"identity": "v2",
"map": "SN (see also Range) or CQ"
},
{
"identity": "rim",
"map": "PQ, IVL, MO, CO, depending on the values"
}]
},
{
"id": "Distance.id",
"path": "Distance.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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": "< | <= | >= | > | ad - how to understand the value",
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.comparator",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How the Quantity should be understood and represented."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}]
},
{
"id": "Distance.unit",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(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"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "CO.codeSystem, PQ.translation.codeSystem"
}]
},
{
"id": "Distance.code",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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.exists() or value.empty()) and (system.empty() or system = %ucum)",
"source": "http://hl7.org/fhir/StructureDefinition/Distance"
}],
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Appropriate units for Distance."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DistanceUnits"
}],
"strength": "extensible",
"description": "Appropriate units for Distance.",
"valueSet": "http://hl7.org/fhir/ValueSet/distance-units",
"additional": [{
"purpose": "maximum",
"valueSet": "http://hl7.org/fhir/ValueSet/all-distance-units"
}]
},
"mapping": [{
"identity": "rim",
"map": "PQ"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Dosage",
"resource": {
"resourceType": "StructureDefinition",
"id": "Dosage",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Dosage ΣTU Element How the medication is/was taken or should be taken
+ Rule: AsNeededFor can only be set if AsNeeded is empty or true
Elements defined in Ancestors: id, extension, modifierExtension sequence Σ 0..1 integer The order of the dosage instructions
text Σ 0..1 string Free text dosage instructions e.g. SIG
additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMED CT Additional Dosage Instructions (Example)
patientInstruction Σ 0..1 string Patient or consumer oriented instructions
timing Σ 0..1 Timing When medication should be administered
asNeeded ΣC 0..1 boolean Take "as needed"
asNeededFor ΣC 0..* CodeableConcept Take "as needed" (for x)
Binding: SNOMED CT Medication As Needed Reason Codes (Example)
site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (Example)
route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMED CT Route Codes (Example)
method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMED CT Administration Method Codes (Example)
doseAndRate Σ 0..* Element Amount of medication administered, to be administered or typical amount to be administered
type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (Example)
dose[x] Σ 0..1 Amount of medication per dose
doseRange Range doseQuantity SimpleQuantity rate[x] Σ 0..1 Amount of medication per unit of time
rateRatio Ratio rateRange Range rateQuantity SimpleQuantity maxDosePerPeriod Σ 0..* Ratio Upper limit on medication per unit of time
maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Dosage",
"version": "5.0.0",
"name": "Dosage",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Dosage",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/BackboneType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Dosage",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "Dosage",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "dos-1",
"severity": "error",
"human": "AsNeededFor can only be set if AsNeeded is empty or true",
"expression": "asNeededFor.empty() or asNeeded.empty() or asNeeded",
"source": "http://hl7.org/fhir/StructureDefinition/Dosage"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,.outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}]
},
{
"id": "Dosage.id",
"path": "Dosage.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Dosage.modifierExtension",
"path": "Dosage.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": ["extensions",
"user content",
"modifiers"],
"min": 0,
"max": "*",
"base": {
"path": "BackboneType.modifierExtension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "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",
"base": {
"path": "Dosage.sequence",
"min": 0,
"max": "1"
},
"type": [{
"code": "integer"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "TQ1-1"
},
{
"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. Additional information about administration or preparation of the medication should be included as text.",
"min": 0,
"max": "1",
"base": {
"path": "Dosage.text",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "RXO-6; RXE-21"
},
{
"identity": "rim",
"map": ".text"
}]
},
{
"id": "Dosage.additionalInstruction",
"path": "Dosage.additionalInstruction",
"short": "Supplemental instruction or warnings to the patient - e.g. \"with meals\", \"may cause drowsiness\"",
"definition": "Supplemental instructions to the patient on how to take the medication (e.g. \"with meals\" or\"take half to one hour before food\") or warnings for the patient about the medication (e.g. \"may cause drowsiness\" or \"avoid exposure of skin to direct sunlight or sunlamps\").",
"comment": "Information about administration or preparation of the medication (e.g. \"infuse as rapidly as possibly via intraperitoneal port\" or take \"immediately following drug x\") should be populated in dosage.text.",
"requirements": "Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, \"Swallow with plenty of water\" which might or might not be coded.",
"min": 0,
"max": "*",
"base": {
"path": "Dosage.additionalInstruction",
"min": 0,
"max": "*"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept identifying additional instructions such as \"take with water\" or \"avoid operating heavy machinery\"."
},
{
"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\".",
"valueSet": "http://hl7.org/fhir/ValueSet/additional-instruction-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXO-7"
},
{
"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",
"base": {
"path": "Dosage.patientInstruction",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "RXO-7"
},
{
"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 might 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. This 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",
"base": {
"path": "Dosage.timing",
"min": 0,
"max": "1"
},
"type": [{
"code": "Timing"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": ".effectiveTime"
}]
},
{
"id": "Dosage.asNeeded",
"path": "Dosage.asNeeded",
"short": "Take \"as needed\"",
"definition": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).",
"comment": "Can express \"as needed\" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated.",
"min": 0,
"max": "1",
"base": {
"path": "Dosage.asNeeded",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"condition": ["dos-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "TQ1-9"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code=\"as needed\"].value=boolean or codable concept"
}]
},
{
"id": "Dosage.asNeededFor",
"path": "Dosage.asNeededFor",
"short": "Take \"as needed\" (for x)",
"definition": "Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).",
"comment": "Can express \"as needed\" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not \"prn\" or \"as needed\".",
"min": 0,
"max": "*",
"base": {
"path": "Dosage.asNeededFor",
"min": 0,
"max": "*"
},
"type": [{
"code": "CodeableConcept"
}],
"condition": ["dos-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "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."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason"
},
"mapping": [{
"identity": "v2",
"map": "TQ1-9"
},
{
"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 [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"requirements": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"base": {
"path": "Dosage.site",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept describing the site location the medicine enters into or onto the body."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/approach-site-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXR-2"
},
{
"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",
"base": {
"path": "Dosage.route",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXR-1"
},
{
"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",
"base": {
"path": "Dosage.method",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept describing the technique by which the medicine is administered."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/administration-method-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXR-4"
},
{
"identity": "rim",
"map": "SubstanceAdministration.methodCode"
}]
},
{
"id": "Dosage.doseAndRate",
"path": "Dosage.doseAndRate",
"short": "Amount of medication administered, to be administered or typical amount to be administered",
"definition": "Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.",
"min": 0,
"max": "*",
"base": {
"path": "Dosage.doseAndRate",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": "SubstanceAdministration.doseQuantity; SubstanceAdministration.RateQuantity"
}]
},
{
"id": "Dosage.doseAndRate.id",
"path": "Dosage.doseAndRate.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Dosage.doseAndRate.extension",
"path": "Dosage.doseAndRate.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Dosage.doseAndRate.type",
"path": "Dosage.doseAndRate.type",
"short": "The kind of dose or rate specified",
"definition": "The kind of dose or rate specified, for example, ordered or calculated.",
"requirements": "If the type is not populated, assume to be \"ordered\".",
"min": 0,
"max": "1",
"base": {
"path": "Dosage.doseAndRate.type",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The kind of dose or rate specified."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DoseAndRateType"
}],
"strength": "example",
"description": "The kind of dose or rate specified.",
"valueSet": "http://terminology.hl7.org/ValueSet/dose-rate-type"
},
"mapping": [{
"identity": "v2",
"map": "RXO-21; RXE-23"
}]
},
{
"id": "Dosage.doseAndRate.dose[x]",
"path": "Dosage.doseAndRate.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",
"base": {
"path": "Dosage.doseAndRate.dose[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "Range"
},
{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "RXO-2, RXE-3"
},
{
"identity": "rim",
"map": ".doseQuantity"
}]
},
{
"id": "Dosage.doseAndRate.rate[x]",
"path": "Dosage.doseAndRate.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.\r\rIt is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.",
"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",
"base": {
"path": "Dosage.doseAndRate.rate[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "Ratio"
},
{
"code": "Range"
},
{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "RXE22, RXE23, RXE-24"
},
{
"identity": "rim",
"map": ".rateQuantity"
}]
},
{
"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": "*",
"base": {
"path": "Dosage.maxDosePerPeriod",
"min": 0,
"max": "*"
},
"type": [{
"code": "Ratio"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "RXO-23, RXE-19"
},
{
"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",
"base": {
"path": "Dosage.maxDosePerAdministration",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "Dosage.maxDosePerLifetime",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "not supported"
}]
}]
},
"differential": {
"element": [{
"id": "Dosage",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"constraint": [{
"key": "dos-1",
"severity": "error",
"human": "AsNeededFor can only be set if AsNeeded is empty or true",
"expression": "asNeededFor.empty() or asNeeded.empty() or asNeeded",
"source": "http://hl7.org/fhir/StructureDefinition/Dosage"
}],
"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": "v2",
"map": "TQ1-1"
},
{
"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. Additional information about administration or preparation of the medication should be included as text.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "RXO-6; RXE-21"
},
{
"identity": "rim",
"map": ".text"
}]
},
{
"id": "Dosage.additionalInstruction",
"path": "Dosage.additionalInstruction",
"short": "Supplemental instruction or warnings to the patient - e.g. \"with meals\", \"may cause drowsiness\"",
"definition": "Supplemental instructions to the patient on how to take the medication (e.g. \"with meals\" or\"take half to one hour before food\") or warnings for the patient about the medication (e.g. \"may cause drowsiness\" or \"avoid exposure of skin to direct sunlight or sunlamps\").",
"comment": "Information about administration or preparation of the medication (e.g. \"infuse as rapidly as possibly via intraperitoneal port\" or take \"immediately following drug x\") should be populated in dosage.text.",
"requirements": "Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, \"Swallow with plenty of water\" which might or might not be coded.",
"min": 0,
"max": "*",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept identifying additional instructions such as \"take with water\" or \"avoid operating heavy machinery\"."
},
{
"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\".",
"valueSet": "http://hl7.org/fhir/ValueSet/additional-instruction-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXO-7"
},
{
"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": "v2",
"map": "RXO-7"
},
{
"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 might 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. This 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",
"path": "Dosage.asNeeded",
"short": "Take \"as needed\"",
"definition": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).",
"comment": "Can express \"as needed\" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated.",
"min": 0,
"max": "1",
"type": [{
"code": "boolean"
}],
"condition": ["dos-1"],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "TQ1-9"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code=\"as needed\"].value=boolean or codable concept"
}]
},
{
"id": "Dosage.asNeededFor",
"path": "Dosage.asNeededFor",
"short": "Take \"as needed\" (for x)",
"definition": "Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).",
"comment": "Can express \"as needed\" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not \"prn\" or \"as needed\".",
"min": 0,
"max": "*",
"type": [{
"code": "CodeableConcept"
}],
"condition": ["dos-1"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "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."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason"
},
"mapping": [{
"identity": "v2",
"map": "TQ1-9"
},
{
"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 [http://hl7.org/fhir/StructureDefinition/bodySite](http://hl7.org/fhir/extensions/StructureDefinition-bodySite.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"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/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept describing the site location the medicine enters into or onto the body."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/approach-site-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXR-2"
},
{
"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/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXR-1"
},
{
"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/tools/StructureDefinition/binding-definition",
"valueString": "A coded concept describing the technique by which the medicine is administered."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/administration-method-codes"
},
"mapping": [{
"identity": "v2",
"map": "RXR-4"
},
{
"identity": "rim",
"map": "SubstanceAdministration.methodCode"
}]
},
{
"id": "Dosage.doseAndRate",
"path": "Dosage.doseAndRate",
"short": "Amount of medication administered, to be administered or typical amount to be administered",
"definition": "Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": "SubstanceAdministration.doseQuantity; SubstanceAdministration.RateQuantity"
}]
},
{
"id": "Dosage.doseAndRate.type",
"path": "Dosage.doseAndRate.type",
"short": "The kind of dose or rate specified",
"definition": "The kind of dose or rate specified, for example, ordered or calculated.",
"requirements": "If the type is not populated, assume to be \"ordered\".",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The kind of dose or rate specified."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DoseAndRateType"
}],
"strength": "example",
"description": "The kind of dose or rate specified.",
"valueSet": "http://terminology.hl7.org/ValueSet/dose-rate-type"
},
"mapping": [{
"identity": "v2",
"map": "RXO-21; RXE-23"
}]
},
{
"id": "Dosage.doseAndRate.dose[x]",
"path": "Dosage.doseAndRate.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": "v2",
"map": "RXO-2, RXE-3"
},
{
"identity": "rim",
"map": ".doseQuantity"
}]
},
{
"id": "Dosage.doseAndRate.rate[x]",
"path": "Dosage.doseAndRate.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.\r\rIt is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.",
"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": "v2",
"map": "RXE22, RXE23, RXE-24"
},
{
"identity": "rim",
"map": ".rateQuantity"
}]
},
{
"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": "*",
"type": [{
"code": "Ratio"
}],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "RXO-23, RXE-19"
},
{
"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"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Duration",
"resource": {
"resourceType": "StructureDefinition",
"id": "Duration",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Duration ΣN Quantity A length of time
Binding: Common UCUM Codes for Duration (Extensible)Additional Bindings Purpose All UCUM Expression for Time Max Binding
+ Rule: 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
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Duration",
"version": "5.0.0",
"name": "Duration",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Duration Type: A length of time.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"base": {
"path": "Duration",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Duration"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}],
"isModifier": false,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Appropriate units for Duration."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DurationUnits"
}],
"strength": "extensible",
"description": "Appropriate units for Duration.",
"valueSet": "http://hl7.org/fhir/ValueSet/duration-units",
"additional": [{
"purpose": "maximum",
"valueSet": "http://hl7.org/fhir/ValueSet/all-time-units"
}]
},
"mapping": [{
"identity": "v2",
"map": "SN (see also Range) or CQ"
},
{
"identity": "rim",
"map": "PQ, IVL, MO, CO, depending on the values,PQ, IVL depending on the values"
}]
},
{
"id": "Duration.id",
"path": "Duration.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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": "< | <= | >= | > | ad - how to understand the value",
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.comparator",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How the Quantity should be understood and represented."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}]
},
{
"id": "Duration.unit",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(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"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "CO.codeSystem, PQ.translation.codeSystem"
}]
},
{
"id": "Duration.code",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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())",
"source": "http://hl7.org/fhir/StructureDefinition/Duration"
}],
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Appropriate units for Duration."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DurationUnits"
}],
"strength": "extensible",
"description": "Appropriate units for Duration.",
"valueSet": "http://hl7.org/fhir/ValueSet/duration-units",
"additional": [{
"purpose": "maximum",
"valueSet": "http://hl7.org/fhir/ValueSet/all-time-units"
}]
},
"mapping": [{
"identity": "rim",
"map": "PQ, IVL depending on the values"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/ElementDefinition",
"resource": {
"resourceType": "StructureDefinition",
"id": "ElementDefinition",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints ElementDefinition ΣN Element Definition of an element in a resource or extension
+ Rule: Min <= Max
+ Rule: if the element definition has a contentReference, it cannot have type, defaultValue, fixed, pattern, example, minValue, maxValue, maxLength, or binding
+ Rule: Fixed value may only be specified if there is one type
+ Rule: Pattern may only be specified if there is one type
+ Rule: Pattern and fixed are mutually exclusive
+ Rule: Binding can only be present for coded elements, string, and uri if using FHIR-defined types
+ Rule: Types must be unique by code
+ Rule: Constraints must be unique by key
+ Rule: default value and meaningWhenMissing are mutually exclusive
+ Rule: sliceName must be composed of proper tokens separated by "/"
+ Rule: Must have a modifier reason if isModifier = true
+ Rule: Element path SHALL be expressed as a set of '.'-separated components with each component restricted to a maximum of 64 characters and with some limits on the allowed choice of characters
+ Warning: The first component of the path should be UpperCamelCase. Additional components (following a '.') should be lowerCamelCase. If this syntax is not adhered to, code generation tools may be broken. Logical models may be less concerned about this implication.
+ Rule: sliceIsConstraining can only appear if slicename is present
+ Guideline: pattern[x] should be used rather than fixed[x]
+ Warning: Order has no meaning (and cannot be asserted to have meaning), so enforcing rules on order is improper
+ Warning: Mappings SHOULD be unique by key
+ Rule: Can't have valueAlternatives if mustHaveValue is true
Elements defined in Ancestors: id, extension, modifierExtension path ΣC 1..1 string Path of the element in the hierarchy of elements
representation Σ 0..* code xmlAttr | xmlText | typeAttr | cdaText | xhtml
Binding: PropertyRepresentation (Required)
sliceName ΣC 0..1 string Name for this particular element (in a set of slices)
sliceIsConstraining ΣCTU 0..1 boolean If this slice definition constrains an inherited slice definition (or not)
label ΣT 0..1 string Name for element to display with or prompt for element
code Σ 0..* Coding Corresponding codes in terminologies
Binding: ElementDefinitionCode (Example)
slicing ΣC 0..1 Element This element is sliced - slices follow
discriminator Σ 0..* Element Element values that are used to distinguish the slices
type Σ 1..1 code value | exists | type | profile | position
Binding: DiscriminatorType (Required)
path Σ 1..1 string Path to element value
description ΣT 0..1 string Text description of how slicing works (or not)
ordered ΣC 0..1 boolean If elements must be in same order as slices
rules ΣC 1..1 code closed | open | openAtEnd
Binding: SlicingRules (Required)
short ΣT 0..1 string Concise definition for space-constrained presentation
definition ΣT 0..1 markdown Full formal definition as narrative text
comment ΣT 0..1 markdown Comments about the use of this element
requirements ΣT 0..1 markdown Why this resource has been created
alias ΣT 0..* string Other names
min ΣC 0..1 unsignedInt Minimum Cardinality
max ΣC 0..1 string Maximum Cardinality (a number or *)
+ Rule: Max SHALL be a number or "*"
base Σ 0..1 Element Base definition information for tools
path Σ 1..1 string Path that identifies the base element
min Σ 1..1 unsignedInt Min cardinality of the base element
max Σ 1..1 string Max cardinality of the base element
contentReference ΣC 0..1 uri Reference to definition of content for the element
type ΣC 0..* Element Data type and Profile for this element
+ Rule: Aggregation may only be specified if one of the allowed types for the element is a reference
+ Rule: targetProfile is only allowed if the type is Reference or canonical
code ΣC 1..1 uri Data type or Resource (reference to definition)
Binding: Element Definition Types (Extensible)
profile Σ 0..* canonical(StructureDefinition | ImplementationGuide) Profiles (StructureDefinition or IG) - one must apply
targetProfile ΣC 0..* canonical(StructureDefinition | ImplementationGuide) Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
aggregation ΣC 0..* code contained | referenced | bundled - how aggregated
Binding: AggregationMode (Required)
versioning Σ 0..1 code either | independent | specific
Binding: ReferenceVersionRules (Required)
defaultValue[x] ΣC 0..1 * Specified value if missing from instance
meaningWhenMissing ΣTC 0..1 markdown Implicit meaning when this element is missing
orderMeaning ΣC 0..1 string What the order of the elements means
fixed[x] ΣC 0..1 * Value must be exactly this
pattern[x] ΣC 0..1 * Value must have at least these property values
example ΣC 0..* Element Example value (as defined for type)
label ΣT 1..1 string Describes the purpose of this example
value[x] Σ 1..1 * Value of Example (one of allowed types)
minValue[x] ΣC 0..1 Minimum Allowed Value (for some types)
minValueDate date minValueDateTime dateTime minValueInstant instant minValueTime time minValueDecimal decimal minValueInteger integer minValueInteger64 integer64 minValuePositiveInt positiveInt minValueUnsignedInt unsignedInt minValueQuantity Quantity maxValue[x] ΣC 0..1 Maximum Allowed Value (for some types)
maxValueDate date maxValueDateTime dateTime maxValueInstant instant maxValueTime time maxValueDecimal decimal maxValueInteger integer maxValueInteger64 integer64 maxValuePositiveInt positiveInt maxValueUnsignedInt unsignedInt maxValueQuantity Quantity maxLength ΣC 0..1 integer Max length for string type data
condition Σ 0..* id Reference to invariant about presence
constraint ΣC 0..* Element Condition that must evaluate to true
+ Warning: Constraints should have an expression or else validators will not be able to enforce them
+ Rule: Errors cannot be suppressed
key ΣC 1..1 id Target of 'condition' reference above
requirements Σ 0..1 markdown Why this constraint is necessary or appropriate
severity ΣC 1..1 code error | warning
Binding: ConstraintSeverity (Required)
suppress ΣCTU 0..1 boolean Suppress warning or hint in profile
human ΣT 1..1 string Human description of constraint
expression ΣC 0..1 string FHIRPath expression of constraint
source Σ 0..1 canonical(StructureDefinition) Reference to original source of constraint
mustHaveValue ΣCTU 0..1 boolean For primitives, that a value must be present - not replaced by an extension
valueAlternatives ΣCTU 0..* canonical(StructureDefinition) Extensions that are allowed to replace a primitive value
mustSupport Σ 0..1 boolean If the element must be supported (discouraged - see obligations)
isModifier ΣC 0..1 boolean If this modifies the meaning of other elements
isModifierReason ΣC 0..1 string Reason that this element is marked as a modifier
isSummary Σ 0..1 boolean Include when _summary = true?
binding ΣC 0..1 Element ValueSet details if this is coded
+ Rule: ValueSet SHALL start with http:// or https:// or urn: or #
+ Rule: binding SHALL have either description or valueSet
strength Σ 1..1 code required | extensible | preferred | example
Binding: BindingStrength (Required)
description ΣTC 0..1 markdown Intended use of codes in the bound value set
valueSet ΣC 0..1 canonical(ValueSet) Source of value set
additional ΣTU 0..* Element Additional Bindings - more rules about the binding
purpose Σ 1..1 code maximum | minimum | required | extensible | candidate | current | preferred | ui | starter | component
Binding: Additional Binding Purpose ValueSet (Required)
valueSet Σ 1..1 canonical(ValueSet) The value set for the additional binding
documentation Σ 0..1 markdown Documentation of the purpose of use of the binding
shortDoco Σ 0..1 string Concise documentation - for summary tables
usage Σ 0..* UsageContext Qualifies the usage - jurisdiction, gender, workflow status etc.
any Σ 0..1 boolean Whether binding can applies to all repeats, or just one
mapping ΣC 0..* Element Map element to another set of definitions
identity ΣC 1..1 id Reference to mapping declaration
language Σ 0..1 code Computable language of mapping
Binding: Mime Types (Required)
map Σ 1..1 string Details of the mapping
comment Σ 0..1 markdown Comments about the mapping or its use
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/ElementDefinition",
"version": "5.0.0",
"name": "ElementDefinition",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"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": "dex",
"uri": "http://ihe.net/data-element-exchange",
"name": "IHE Data Element Exchange (DEX)"
}],
"kind": "complex-type",
"abstract": false,
"type": "ElementDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/BackboneType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "ElementDefinition",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"base": {
"path": "ElementDefinition",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "eld-2",
"severity": "error",
"human": "Min <= Max",
"expression": "min.empty() or max.empty() or (max = '*') or iif(max != '*', min <= max.toInteger())",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-6",
"severity": "error",
"human": "Fixed value may only be specified if there is one type",
"expression": "fixed.empty() or (type.count() <= 1)",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-7",
"severity": "error",
"human": "Pattern may only be specified if there is one type",
"expression": "pattern.empty() or (type.count() <= 1)",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-8",
"severity": "error",
"human": "Pattern and fixed are mutually exclusive",
"expression": "pattern.empty() or fixed.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-11",
"severity": "error",
"human": "Binding can only be present for coded elements, string, and uri if using FHIR-defined types",
"expression": "binding.empty() or type.code.empty() or type.code.contains(\":\") or type.select((code = 'code') or (code = 'Coding') or (code='CodeableConcept') or (code = 'Quantity') or (code = 'string') or (code = 'uri') or (code = 'Duration')).exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-13",
"severity": "error",
"human": "Types must be unique by code",
"expression": "type.select(code).isDistinct()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-14",
"severity": "error",
"human": "Constraints must be unique by key",
"expression": "constraint.select(key).isDistinct()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-15",
"severity": "error",
"human": "default value and meaningWhenMissing are mutually exclusive",
"expression": "defaultValue.empty() or meaningWhenMissing.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"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\\\\/\\\\-_\\\\[\\\\]\\\\@]+$')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-18",
"severity": "error",
"human": "Must have a modifier reason if isModifier = true",
"expression": "(isModifier.exists() and isModifier) implies isModifierReason.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-19",
"severity": "error",
"human": "Element path SHALL be expressed as a set of '.'-separated components with each component restricted to a maximum of 64 characters and with some limits on the allowed choice of characters",
"expression": "path.matches('^[^\\\\s\\\\.,:;\\\\\\'\"\\\\/|?!@#$%&*()\\\\[\\\\]{}]{1,64}(\\\\.[^\\\\s\\\\.,:;\\\\\\'\"\\\\/|?!@#$%&*()\\\\[\\\\]{}]{1,64}(\\\\[x\\\\])?(\\\\:[^\\\\s\\\\.]+)?)*$')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-20",
"severity": "warning",
"human": "The first component of the path should be UpperCamelCase. Additional components (following a '.') should be lowerCamelCase. If this syntax is not adhered to, code generation tools may be broken. Logical models may be less concerned about this implication.",
"expression": "path.matches('^[A-Za-z][A-Za-z0-9]{0,63}(\\\\.[a-z][A-Za-z0-9]{0,63}(\\\\[x])?)*$')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-22",
"severity": "error",
"human": "sliceIsConstraining can only appear if slicename is present",
"expression": "sliceIsConstraining.exists() implies sliceName.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "pattern[x] is generally preferred over fixed[x] because it doesn't preclude the use of id and additional extensions, though there are corner cases when it's appropriate to exclude those"
}],
"key": "eld-24",
"severity": "warning",
"human": "pattern[x] should be used rather than fixed[x]",
"expression": "fixed.exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-25",
"severity": "warning",
"human": "Order has no meaning (and cannot be asserted to have meaning), so enforcing rules on order is improper",
"expression": "orderMeaning.empty() implies slicing.where(rules='openAtEnd' or ordered).exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-27",
"severity": "warning",
"human": "Mappings SHOULD be unique by key",
"expression": "mapping.select(identity).isDistinct()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-28",
"severity": "error",
"human": "Can't have valueAlternatives if mustHaveValue is true",
"expression": "mustHaveValue.value implies valueAlternatives.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,Observation[classCode=OBS, moodCode=DEFN]"
},
{
"identity": "v2",
"map": "OM1"
},
{
"identity": "iso11179",
"map": "Data_Element"
},
{
"identity": "dex",
"map": "RetrieveMetadata response"
}]
},
{
"id": "ElementDefinition.id",
"path": "ElementDefinition.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.modifierExtension",
"path": "ElementDefinition.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": ["extensions",
"user content",
"modifiers"],
"min": 0,
"max": "*",
"base": {
"path": "BackboneType.modifierExtension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "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",
"base": {
"path": "ElementDefinition.path",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["eld-19",
"eld-20"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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. No extensions are allowed on elements with a representation of 'xmlAttr', no matter what FHIR serialization format is used.",
"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": "*",
"base": {
"path": "ElementDefinition.representation",
"min": 0,
"max": "*"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How a property is represented when serialized."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PropertyRepresentation"
}],
"strength": "required",
"description": "How a property is represented when serialized.",
"valueSet": "http://hl7.org/fhir/ValueSet/property-representation|5.0.0"
},
"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",
"base": {
"path": "ElementDefinition.sliceName",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["eld-22",
"eld-16"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.sliceIsConstraining",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.sliceIsConstraining",
"short": "If this slice definition constrains an inherited slice definition (or not)",
"definition": "If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.",
"comment": "If set to true, an ancestor profile SHALL have a slicing definition with this name. If set to false, no ancestor profile is permitted to have a slicing definition with this name.",
"requirements": "Allows detection of a situation where an ancestor profile adds or removes slicing with the same name where that might impact the child profile.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.sliceIsConstraining",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"condition": ["eld-22"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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
},
{
"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](http://hl7.org/fhir/extensions/StructureDefinition-elementdefinition-question.html).",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.label",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "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": "*",
"base": {
"path": "ElementDefinition.code",
"min": 0,
"max": "*"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Codes that indicate the meaning of a data element."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ElementDefinitionCode"
}],
"strength": "example",
"description": "Codes that indicate the meaning of a data element.",
"valueSet": "http://loinc.org/vs"
},
"mapping": [{
"identity": "v2",
"map": "OM1.7"
},
{
"identity": "rim",
"map": "./code (root or translation)"
},
{
"identity": "iso11179",
"map": "(Data_Element).data_element_concept.identifier"
}]
},
{
"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",
"base": {
"path": "ElementDefinition.slicing",
"min": 0,
"max": "1"
},
"type": [{
"code": "Element"
}],
"condition": ["eld-25"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.slicing.id",
"path": "ElementDefinition.slicing.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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.",
"min": 0,
"max": "*",
"base": {
"path": "ElementDefinition.slicing.discriminator",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.slicing.discriminator.type",
"path": "ElementDefinition.slicing.discriminator.type",
"short": "value | exists | type | profile | position",
"definition": "How the element value is interpreted when discrimination is evaluated.",
"comment": "'pattern' is deprecated - it works exactly the same as 'value'.",
"min": 1,
"max": "1",
"base": {
"path": "ElementDefinition.slicing.discriminator.type",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How an element value is interpreted when discrimination is evaluated."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DiscriminatorType"
}],
"strength": "required",
"description": "How an element value is interpreted when discrimination is evaluated.",
"valueSet": "http://hl7.org/fhir/ValueSet/discriminator-type|5.0.0"
},
"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 [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.",
"min": 1,
"max": "1",
"base": {
"path": "ElementDefinition.slicing.discriminator.path",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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
},
{
"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",
"base": {
"path": "ElementDefinition.slicing.description",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.slicing.ordered",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"meaningWhenMissing": "Order is not required unless specified",
"condition": ["eld-25"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
},
{
"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",
"base": {
"path": "ElementDefinition.slicing.rules",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["eld-25"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How slices are interpreted when evaluating an instance."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SlicingRules"
}],
"strength": "required",
"description": "How slices are interpreted when evaluating an instance.",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-slicing-rules|5.0.0"
},
"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
},
{
"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": "It is easy for a different short definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing short definitions in a profile.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.short",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "N/A"
}]
},
{
"id": "ElementDefinition.definition",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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. (Note: The text you are reading is specified in ElementDefinition.definition).",
"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 in a profile.",
"requirements": "To allow a user to state the usage of an element in a particular context.",
"alias": ["Description"],
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.definition",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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"
}]
},
{
"id": "ElementDefinition.comment",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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. (Note: The text you are reading is specified in ElementDefinition.comment).",
"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",
"base": {
"path": "ElementDefinition.comment",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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"
}]
},
{
"id": "ElementDefinition.requirements",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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",
"base": {
"path": "ElementDefinition.requirements",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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"
}]
},
{
"id": "ElementDefinition.alias",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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": "*",
"base": {
"path": "ElementDefinition.alias",
"min": 0,
"max": "*"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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"
}]
},
{
"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",
"base": {
"path": "ElementDefinition.min",
"min": 0,
"max": "1"
},
"type": [{
"code": "unsignedInt"
}],
"condition": ["eld-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.max",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["eld-2"],
"constraint": [{
"key": "eld-3",
"severity": "error",
"human": "Max SHALL be a number or \"*\"",
"expression": "empty() or ($this = '*') or (toInteger() >= 0)",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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. When the element definition is not the original definition of an element - e.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.",
"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. For tooling simplicity, the base information must always be populated in element definitions in snap shots, even if it is the same.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.base",
"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() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "ElementDefinition.base.path",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.base.min",
"min": 1,
"max": "1"
},
"type": [{
"code": "unsignedInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.base.max",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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 an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.",
"comment": "ContentReferences can only be defined in specializations, not constrained types, and they cannot be changed and always reference the non-constrained definition.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.contentReference",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"condition": ["eld-5"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "*",
"base": {
"path": "ElementDefinition.type",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"condition": ["eld-13",
"eld-7",
"eld-6",
"eld-11",
"eld-5"],
"constraint": [{
"key": "eld-4",
"severity": "error",
"human": "Aggregation may only be specified if one of the allowed types for the element is a reference",
"expression": "aggregation.empty() or (code = 'Reference') or (code = 'canonical') or (code = 'CodeableReference')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-17",
"severity": "error",
"human": "targetProfile is only allowed if the type is Reference or canonical",
"expression": "(code='Reference' or code = 'canonical' or code = 'CodeableReference') or targetProfile.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "OM1.3, OMC.9"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain.data+Q14type"
},
{
"identity": "dex",
"map": "valueDomain.dataType"
}]
},
{
"id": "ElementDefinition.type.id",
"path": "ElementDefinition.type.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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).",
"min": 1,
"max": "1",
"base": {
"path": "ElementDefinition.type.code",
"min": 1,
"max": "1"
},
"type": [{
"code": "uri"
}],
"condition": ["eld-11",
"eld-13",
"eld-4",
"eld-17"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "List of all Types for ElementDefinition.type.code."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ElementDefinitionTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "extensible",
"description": "List of all Types for ElementDefinition.type.code.",
"valueSet": "http://hl7.org/fhir/ValueSet/elementdefinition-types"
},
"mapping": [{
"identity": "v2",
"map": "OM1.3"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain.data+Q14type"
}]
},
{
"id": "ElementDefinition.type.profile",
"path": "ElementDefinition.type.profile",
"short": "Profiles (StructureDefinition or IG) - one must apply",
"definition": "Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL 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 type SHALL conform to at least one profile defined in the implementation guide.",
"comment": "It is possible to profile backbone element (e.g. part of a resource), using the [http://hl7.org/fhir/StructureDefinition/elementdefinition-profile-element](http://hl7.org/fhir/extensions/StructureDefinition-elementdefinition-profile-element.html) extension.",
"min": 0,
"max": "*",
"base": {
"path": "ElementDefinition.type.profile",
"min": 0,
"max": "*"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.type.targetProfile",
"path": "ElementDefinition.type.targetProfile",
"short": "Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply",
"definition": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL 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 target resource SHALL conform to at least one profile defined in the implementation guide.",
"min": 0,
"max": "*",
"base": {
"path": "ElementDefinition.type.targetProfile",
"min": 0,
"max": "*"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"condition": ["eld-17"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (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.",
"comment": "See [Aggregation Rules](elementdefinition.html#aggregation) for further clarification.",
"min": 0,
"max": "*",
"base": {
"path": "ElementDefinition.type.aggregation",
"min": 0,
"max": "*"
},
"type": [{
"code": "code"
}],
"condition": ["eld-4"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How resource references can be aggregated."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AggregationMode"
}],
"strength": "required",
"description": "How resource references can be aggregated.",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-aggregation-mode|5.0.0"
},
"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. See [Aggregation Rules](elementdefinition.html#aggregation) for further clarification.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.type.versioning",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Whether a reference needs to be version specific or version independent, or whether either can be used."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/reference-version-rules|5.0.0"
},
"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": "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, or changed in constraints on content models. Defining default values creates many difficulties in implementation (e.g. when is a value missing?). For these reasons, default values are (and should be) used extremely sparingly. \n\nNo default values are ever defined in the FHIR specification, nor can they be defined in constraints (\"profiles\") on data types or resources. This element only exists so that default values may be defined in logical models.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.defaultValue[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["eld-15",
"eld-5"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.meaningWhenMissing",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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",
"base": {
"path": "ElementDefinition.meaningWhenMissing",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"condition": ["eld-15"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (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",
"base": {
"path": "ElementDefinition.orderMeaning",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["eld-25"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (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, if present. 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",
"base": {
"path": "ElementDefinition.fixed[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["eld-5",
"eld-6",
"eld-8",
"eld-24"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (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 each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"comment": "Mostly used for fixing values of CodeableConcept. In general, pattern[x] is not intended for use with primitive types, where is has the same meaning as fixed[x].",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.pattern[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["eld-5",
"eld-7",
"eld-8"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "*",
"base": {
"path": "ElementDefinition.example",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"condition": ["eld-5"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.example.id",
"path": "ElementDefinition.example.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.example.label",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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 among the set of examples.",
"min": 1,
"max": "1",
"base": {
"path": "ElementDefinition.example.label",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.example.value[x]",
"min": 1,
"max": "1"
},
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".example"
}]
},
{
"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 [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 a canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.minValue[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "instant"
},
{
"code": "time"
},
{
"code": "decimal"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "positiveInt"
},
{
"code": "unsignedInt"
},
{
"code": "Quantity"
}],
"condition": ["eld-5"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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 [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 a canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.maxValue[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "instant"
},
{
"code": "time"
},
{
"code": "decimal"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "positiveInt"
},
{
"code": "unsignedInt"
},
{
"code": "Quantity"
}],
"condition": ["eld-5"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.maxLength",
"path": "ElementDefinition.maxLength",
"short": "Max length for string type data",
"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. ```maxLength``` SHOULD only be used on primitive data types that have a string representation (see [http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics](http://hl7.org/fhir/extensions/StructureDefinition-structuredefinition-type-characteristics.html)).",
"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",
"base": {
"path": "ElementDefinition.maxLength",
"min": 0,
"max": "1"
},
"type": [{
"code": "integer"
}],
"condition": ["eld-5"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "*",
"base": {
"path": "ElementDefinition.condition",
"min": 0,
"max": "*"
},
"type": [{
"code": "id"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "*",
"base": {
"path": "ElementDefinition.constraint",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"condition": ["eld-14"],
"constraint": [{
"key": "eld-21",
"severity": "warning",
"human": "Constraints should have an expression or else validators will not be able to enforce them",
"expression": "expression.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-26",
"severity": "error",
"human": "Errors cannot be suppressed",
"expression": "(severity = 'error') implies suppress.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": "??"
}]
},
{
"id": "ElementDefinition.constraint.id",
"path": "ElementDefinition.constraint.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "ElementDefinition.constraint.key",
"min": 1,
"max": "1"
},
"type": [{
"code": "id"
}],
"condition": ["eld-14"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (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 might not be intuitive to all implementers.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.constraint.requirements",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.constraint.severity",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["eld-26"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "SHALL applications comply with this constraint?"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConstraintSeverity"
}],
"strength": "required",
"description": "SHALL applications comply with this constraint?",
"valueSet": "http://hl7.org/fhir/ValueSet/constraint-severity|5.0.0"
},
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.constraint.suppress",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.constraint.suppress",
"short": "Suppress warning or hint in profile",
"definition": "If true, indicates that the warning or best practice guideline should be suppressed.",
"comment": "This element should only be present in a derived profile where a warning or hint has been determined to be spurious/incorrect. E.g. a warning encouraging the inclusion of an element that the profile explicitly prohibits.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.constraint.suppress",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"condition": ["eld-26"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.constraint.human",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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",
"base": {
"path": "ElementDefinition.constraint.human",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.",
"comment": "In the absense of an expression, the expression is likely not enforceable by validators, and might be missed by many systems.",
"requirements": "Used by validation tooling tests of the validity of the resource.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.constraint.expression",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["eld-21"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (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",
"base": {
"path": "ElementDefinition.constraint.source",
"min": 0,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.mustHaveValue",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.mustHaveValue",
"short": "For primitives, that a value must be present - not replaced by an extension",
"definition": "Specifies for a primitive data type that the value of the data type cannot be replaced by an extension.",
"comment": "Typical extensions that can be provided in place of a the value are [http://hl7.org/fhir/StructureDefinition/data-absent-reason](http://hl7.org/fhir/extensions/StructureDefinition-data-absent-reason.html), [http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor](http://hl7.org/fhir/extensions/StructureDefinition-iso21090-nullFlavor.html), [http://hl7.org/fhir/StructureDefinition/originalText](http://hl7.org/fhir/extensions/StructureDefinition-originalText.html), and [http://hl7.org/fhir/StructureDefinition/cqf-expression](http://hl7.org/fhir/extensions/StructureDefinition-cqf-expression.html). Note that this element has no meaning when a value is provided, and extensions can be provided in addition to a value.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.mustHaveValue",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"condition": ["eld-28"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ElementDefinition.valueAlternatives",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.valueAlternatives",
"short": "Extensions that are allowed to replace a primitive value",
"definition": "Specifies a list of extensions that can appear in place of a primitive value.",
"comment": "if mustHaveValue is true, then this element should not be present, since no extensions are allowed in place of the value. Note that this element has no impact if the value is present.",
"min": 0,
"max": "*",
"base": {
"path": "ElementDefinition.valueAlternatives",
"min": 0,
"max": "*"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"meaningWhenMissing": "If this element is missing, then any extension can be used if its context is appropriate",
"condition": ["eld-28"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ElementDefinition.mustSupport",
"path": "ElementDefinition.mustSupport",
"short": "If the element must be supported (discouraged - see obligations)",
"definition": "If true, implementations that produce or consume resources SHALL provide \"support\" for the element in some meaningful way. Note that this is being phased out and replaced by obligations (see below). If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.",
"comment": "\"Something meaningful\" is context dependent and impossible to describe in the base FHIR specification. For this reason, the mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. A profile on a type can always make mustSupport = true if it is false in the base type but cannot make mustSupport = false if it is true in the base type. This 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. Note 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",
"base": {
"path": "ElementDefinition.mustSupport",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"meaningWhenMissing": "In a base type, where the element is being defined for the first time, the element is assumed to be mustSupport = false. In a profile (a constraint on an existing type), if mustSupport is not specific in either the differential or the snapshot, the mustSupport value is not changed from the base definition. Note, though, that the snapshot SHOULD always populate the mustSupport value",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": 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. When used on the root element in an extension definition, this indicates whether or not the extension is a modifier extension.",
"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 (except in the special case of the defining a new extension). 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",
"base": {
"path": "ElementDefinition.isModifier",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"meaningWhenMissing": "An element is not a modifier element unless it is explicitly specified to be one",
"condition": ["eld-18"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": "??"
}]
},
{
"id": "ElementDefinition.isModifierReason",
"path": "ElementDefinition.isModifierReason",
"short": "Reason that this element is marked as a modifier",
"definition": "Explains how that element affects the interpretation of the resource or element that contains it.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.isModifierReason",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["eld-18"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"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. When a request is made with _summary=true, serializers only include elements marked as 'isSummary = true'. With a few exceptions (listed below), all datatype properties are included in the summary form. In resource and datatype definitions, if an element has a descendant marked as isSummary=true or if it satisfies both of the following conditions, it must be marked as isSummary=true:\n* is at the root or has a parent that is 'mustSupport'\n* has a minimum cardinality of 1 or is a modifier element\n\nThe following datatype properties are exceptions, and are not marked as isSummary:\n* Attachment.data\n* Signature.data, Signature.targetFormat, Signature.sigFormat\n* Narrative.status, Narrative.div\n* SampledData.data.",
"requirements": "Allow clients to search through large resources quickly.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.isSummary",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"meaningWhenMissing": "An element is not included in the summary unless it is explicitly specified to be so",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (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",
"base": {
"path": "ElementDefinition.binding",
"min": 0,
"max": "1"
},
"type": [{
"code": "Element"
}],
"condition": ["eld-11",
"eld-5"],
"constraint": [{
"key": "eld-12",
"severity": "error",
"human": "ValueSet SHALL start with http:// or https:// or urn: or #",
"expression": "valueSet.exists() implies (valueSet.startsWith('http:') or valueSet.startsWith('https') or valueSet.startsWith('urn:') or valueSet.startsWith('#'))",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-23",
"severity": "error",
"human": "binding SHALL have either description or valueSet",
"expression": "description.exists() or valueSet.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "OM3, OMC.11"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain"
}]
},
{
"id": "ElementDefinition.binding.id",
"path": "ElementDefinition.binding.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "ElementDefinition.binding.strength",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Indication of the degree of conformance expectations associated with a binding."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/binding-strength|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.binding.description",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}],
"path": "ElementDefinition.binding.description",
"short": "Intended use of codes in the bound value set",
"definition": "Describes the intended use of this particular set of codes.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.binding.description",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"condition": ["eld-23"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain.description"
}]
},
{
"id": "ElementDefinition.binding.valueSet",
"path": "ElementDefinition.binding.valueSet",
"short": "Source of value set",
"definition": "Refers to the value set that identifies the set of codes the binding refers to.",
"comment": "The reference may be version-specific or not (e.g. have a |[version] at the end of the canonical URL).",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.binding.valueSet",
"min": 0,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"condition": ["eld-12",
"eld-23"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": "points to explicit list or expression that evaluates to list of (Enumerated_Value_Domain).member"
},
{
"identity": "dex",
"map": "valueDomain.valueSet"
}]
},
{
"id": "ElementDefinition.binding.additional",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.binding.additional",
"short": "Additional Bindings - more rules about the binding",
"definition": "Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.",
"min": 0,
"max": "*",
"base": {
"path": "ElementDefinition.binding.additional",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.id",
"path": "ElementDefinition.binding.additional.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.binding.additional.extension",
"path": "ElementDefinition.binding.additional.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.binding.additional.purpose",
"path": "ElementDefinition.binding.additional.purpose",
"short": "maximum | minimum | required | extensible | candidate | current | preferred | ui | starter | component",
"definition": "The use of this additional binding.",
"comment": "Conformance bindings are in addition to the base binding, not instead of it.",
"min": 1,
"max": "1",
"base": {
"path": "ElementDefinition.binding.additional.purpose",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The use of an additional binding."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdditionalBindingPurpose"
}],
"strength": "required",
"description": "The use of an additional binding.",
"valueSet": "http://hl7.org/fhir/ValueSet/additional-binding-purpose|5.0.0"
}
},
{
"id": "ElementDefinition.binding.additional.valueSet",
"path": "ElementDefinition.binding.additional.valueSet",
"short": "The value set for the additional binding",
"definition": "The valueSet that is being bound for the purpose.",
"min": 1,
"max": "1",
"base": {
"path": "ElementDefinition.binding.additional.valueSet",
"min": 1,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.documentation",
"path": "ElementDefinition.binding.additional.documentation",
"short": "Documentation of the purpose of use of the binding",
"definition": "Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.binding.additional.documentation",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.shortDoco",
"path": "ElementDefinition.binding.additional.shortDoco",
"short": "Concise documentation - for summary tables",
"definition": "Concise documentation - for summary tables.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.binding.additional.shortDoco",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.usage",
"path": "ElementDefinition.binding.additional.usage",
"short": "Qualifies the usage - jurisdiction, gender, workflow status etc.",
"definition": "Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.",
"comment": "This specification does not define exactly how the context is determined for the usage; typically, this will be described in implementation guides.",
"min": 0,
"max": "*",
"base": {
"path": "ElementDefinition.binding.additional.usage",
"min": 0,
"max": "*"
},
"type": [{
"code": "UsageContext"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.any",
"path": "ElementDefinition.binding.additional.any",
"short": "Whether binding can applies to all repeats, or just one",
"definition": "Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.",
"comment": "A common pattern is to make a conformance binding to all repeats, and then make a binding that one of the repeats must conform to.",
"min": 0,
"max": "1",
"base": {
"path": "ElementDefinition.binding.additional.any",
"min": 0,
"max": "1"
},
"type": [{
"code": "boolean"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"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": "*",
"base": {
"path": "ElementDefinition.mapping",
"min": 0,
"max": "*"
},
"type": [{
"code": "Element"
}],
"condition": ["eld-27"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"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)"
},
{
"identity": "dex",
"map": "mappingSpecification"
}]
},
{
"id": "ElementDefinition.mapping.id",
"path": "ElementDefinition.mapping.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "ElementDefinition.mapping.identity",
"min": 1,
"max": "1"
},
"type": [{
"code": "id"
}],
"condition": ["eld-27"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.mapping.language",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"
},
"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",
"base": {
"path": "ElementDefinition.mapping.map",
"min": 1,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ElementDefinition.mapping.comment",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
}]
},
"differential": {
"element": [{
"id": "ElementDefinition",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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-19",
"severity": "error",
"human": "Element path SHALL be expressed as a set of '.'-separated components with each component restricted to a maximum of 64 characters and with some limits on the allowed choice of characters",
"expression": "path.matches('^[^\\\\s\\\\.,:;\\\\\\'\"\\\\/|?!@#$%&*()\\\\[\\\\]{}]{1,64}(\\\\.[^\\\\s\\\\.,:;\\\\\\'\"\\\\/|?!@#$%&*()\\\\[\\\\]{}]{1,64}(\\\\[x\\\\])?(\\\\:[^\\\\s\\\\.]+)?)*$')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-2",
"severity": "error",
"human": "Min <= Max",
"expression": "min.empty() or max.empty() or (max = '*') or iif(max != '*', min <= max.toInteger())",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-7",
"severity": "error",
"human": "Pattern may only be specified if there is one type",
"expression": "pattern.empty() or (type.count() <= 1)",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-6",
"severity": "error",
"human": "Fixed value may only be specified if there is one type",
"expression": "fixed.empty() or (type.count() <= 1)",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-22",
"severity": "error",
"human": "sliceIsConstraining can only appear if slicename is present",
"expression": "sliceIsConstraining.exists() implies sliceName.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-11",
"severity": "error",
"human": "Binding can only be present for coded elements, string, and uri if using FHIR-defined types",
"expression": "binding.empty() or type.code.empty() or type.code.contains(\":\") or type.select((code = 'code') or (code = 'Coding') or (code='CodeableConcept') or (code = 'Quantity') or (code = 'string') or (code = 'uri') or (code = 'Duration')).exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-8",
"severity": "error",
"human": "Pattern and fixed are mutually exclusive",
"expression": "pattern.empty() or fixed.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-25",
"severity": "warning",
"human": "Order has no meaning (and cannot be asserted to have meaning), so enforcing rules on order is improper",
"expression": "orderMeaning.empty() implies slicing.where(rules='openAtEnd' or ordered).exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-14",
"severity": "error",
"human": "Constraints must be unique by key",
"expression": "constraint.select(key).isDistinct()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "pattern[x] is generally preferred over fixed[x] because it doesn't preclude the use of id and additional extensions, though there are corner cases when it's appropriate to exclude those"
}],
"key": "eld-24",
"severity": "warning",
"human": "pattern[x] should be used rather than fixed[x]",
"expression": "fixed.exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-13",
"severity": "error",
"human": "Types must be unique by code",
"expression": "type.select(code).isDistinct()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-27",
"severity": "warning",
"human": "Mappings SHOULD be unique by key",
"expression": "mapping.select(identity).isDistinct()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"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\\\\/\\\\-_\\\\[\\\\]\\\\@]+$')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-15",
"severity": "error",
"human": "default value and meaningWhenMissing are mutually exclusive",
"expression": "defaultValue.empty() or meaningWhenMissing.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-18",
"severity": "error",
"human": "Must have a modifier reason if isModifier = true",
"expression": "(isModifier.exists() and isModifier) implies isModifierReason.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-28",
"severity": "error",
"human": "Can't have valueAlternatives if mustHaveValue is true",
"expression": "mustHaveValue.value implies valueAlternatives.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-20",
"severity": "warning",
"human": "The first component of the path should be UpperCamelCase. Additional components (following a '.') should be lowerCamelCase. If this syntax is not adhered to, code generation tools may be broken. Logical models may be less concerned about this implication.",
"expression": "path.matches('^[A-Za-z][A-Za-z0-9]{0,63}(\\\\.[a-z][A-Za-z0-9]{0,63}(\\\\[x])?)*$')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
}],
"mapping": [{
"identity": "v2",
"map": "OM1"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=DEFN]"
},
{
"identity": "iso11179",
"map": "Data_Element"
},
{
"identity": "dex",
"map": "RetrieveMetadata response"
}]
},
{
"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"
}],
"condition": ["eld-19",
"eld-20"],
"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. No extensions are allowed on elements with a representation of 'xmlAttr', no matter what FHIR serialization format is used.",
"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/tools/StructureDefinition/binding-definition",
"valueString": "How a property is represented when serialized."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PropertyRepresentation"
}],
"strength": "required",
"description": "How a property is represented when serialized.",
"valueSet": "http://hl7.org/fhir/ValueSet/property-representation|5.0.0"
},
"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"
}],
"condition": ["eld-22",
"eld-16"],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "n/a"
}]
},
{
"id": "ElementDefinition.sliceIsConstraining",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.sliceIsConstraining",
"short": "If this slice definition constrains an inherited slice definition (or not)",
"definition": "If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.",
"comment": "If set to true, an ancestor profile SHALL have a slicing definition with this name. If set to false, no ancestor profile is permitted to have a slicing definition with this name.",
"requirements": "Allows detection of a situation where an ancestor profile adds or removes slicing with the same name where that might impact the child profile.",
"min": 0,
"max": "1",
"type": [{
"code": "boolean"
}],
"condition": ["eld-22"],
"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
},
{
"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](http://hl7.org/fhir/extensions/StructureDefinition-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/tools/StructureDefinition/binding-definition",
"valueString": "Codes that indicate the meaning of a data element."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ElementDefinitionCode"
}],
"strength": "example",
"description": "Codes that indicate the meaning of a data element.",
"valueSet": "http://loinc.org/vs"
},
"mapping": [{
"identity": "v2",
"map": "OM1.7"
},
{
"identity": "rim",
"map": "./code (root or translation)"
},
{
"identity": "iso11179",
"map": "(Data_Element).data_element_concept.identifier"
}]
},
{
"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"
}],
"condition": ["eld-25"],
"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.",
"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 | type | profile | position",
"definition": "How the element value is interpreted when discrimination is evaluated.",
"comment": "'pattern' is deprecated - it works exactly the same as 'value'.",
"min": 1,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How an element value is interpreted when discrimination is evaluated."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DiscriminatorType"
}],
"strength": "required",
"description": "How an element value is interpreted when discrimination is evaluated.",
"valueSet": "http://hl7.org/fhir/ValueSet/discriminator-type|5.0.0"
},
"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 [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.",
"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
},
{
"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"
}],
"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"
}],
"meaningWhenMissing": "Order is not required unless specified",
"condition": ["eld-25"],
"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"
}],
"condition": ["eld-25"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How slices are interpreted when evaluating an instance."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SlicingRules"
}],
"strength": "required",
"description": "How slices are interpreted when evaluating an instance.",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-slicing-rules|5.0.0"
},
"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
},
{
"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": "It is easy for a different short definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing short definitions in a profile.",
"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
},
{
"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. (Note: The text you are reading is specified in ElementDefinition.definition).",
"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 in a profile.",
"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"
}]
},
{
"id": "ElementDefinition.comment",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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. (Note: The text you are reading is specified in ElementDefinition.comment).",
"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"
}]
},
{
"id": "ElementDefinition.requirements",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}]
},
{
"id": "ElementDefinition.alias",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}]
},
{
"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-2"],
"constraint": [{
"key": "eld-3",
"severity": "error",
"human": "Max SHALL be a number or \"*\"",
"expression": "empty() or ($this = '*') or (toInteger() >= 0)",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
}],
"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. When the element definition is not the original definition of an element - e.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.",
"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. For tooling simplicity, the base information must always be populated in element definitions in snap shots, even if it is the same.",
"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 an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.",
"comment": "ContentReferences can only be defined in specializations, not constrained types, and they cannot be changed and always reference the non-constrained definition.",
"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",
"eld-7",
"eld-6",
"eld-11",
"eld-5"],
"constraint": [{
"key": "eld-4",
"severity": "error",
"human": "Aggregation may only be specified if one of the allowed types for the element is a reference",
"expression": "aggregation.empty() or (code = 'Reference') or (code = 'canonical') or (code = 'CodeableReference')",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-17",
"severity": "error",
"human": "targetProfile is only allowed if the type is Reference or canonical",
"expression": "(code='Reference' or code = 'canonical' or code = 'CodeableReference') or targetProfile.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
}],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "OM1.3, OMC.9"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain.data+Q14type"
},
{
"identity": "dex",
"map": "valueDomain.dataType"
}]
},
{
"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).",
"min": 1,
"max": "1",
"type": [{
"code": "uri"
}],
"condition": ["eld-11",
"eld-13",
"eld-4",
"eld-17"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "List of all Types for ElementDefinition.type.code."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ElementDefinitionTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "extensible",
"description": "List of all Types for ElementDefinition.type.code.",
"valueSet": "http://hl7.org/fhir/ValueSet/elementdefinition-types"
},
"mapping": [{
"identity": "v2",
"map": "OM1.3"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain.data+Q14type"
}]
},
{
"id": "ElementDefinition.type.profile",
"path": "ElementDefinition.type.profile",
"short": "Profiles (StructureDefinition or IG) - one must apply",
"definition": "Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL 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 type SHALL conform to at least one profile defined in the implementation guide.",
"comment": "It is possible to profile backbone element (e.g. part of a resource), using the [http://hl7.org/fhir/StructureDefinition/elementdefinition-profile-element](http://hl7.org/fhir/extensions/StructureDefinition-elementdefinition-profile-element.html) extension.",
"min": 0,
"max": "*",
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"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 or IG) on the Reference/canonical target - one must apply",
"definition": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL 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 target resource SHALL conform to at least one profile defined in the implementation guide.",
"min": 0,
"max": "*",
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"condition": ["eld-17"],
"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.",
"comment": "See [Aggregation Rules](elementdefinition.html#aggregation) for further clarification.",
"min": 0,
"max": "*",
"type": [{
"code": "code"
}],
"condition": ["eld-4"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How resource references can be aggregated."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AggregationMode"
}],
"strength": "required",
"description": "How resource references can be aggregated.",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-aggregation-mode|5.0.0"
},
"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. See [Aggregation Rules](elementdefinition.html#aggregation) for further clarification.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Whether a reference needs to be version specific or version independent, or whether either can be used."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/reference-version-rules|5.0.0"
},
"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": "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, or changed in constraints on content models. Defining default values creates many difficulties in implementation (e.g. when is a value missing?). For these reasons, default values are (and should be) used extremely sparingly. \n\nNo default values are ever defined in the FHIR specification, nor can they be defined in constraints (\"profiles\") on data types or resources. This element only exists so that default values may be defined in logical models.",
"min": 0,
"max": "1",
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["eld-15",
"eld-5"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.meaningWhenMissing",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"condition": ["eld-25"],
"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, if present. 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": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["eld-5",
"eld-6",
"eld-8",
"eld-24"],
"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 each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value\n\nIf a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have.",
"comment": "Mostly used for fixing values of CodeableConcept. In general, pattern[x] is not intended for use with primitive types, where is has the same meaning as fixed[x].",
"min": 0,
"max": "1",
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["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"
}],
"condition": ["eld-5"],
"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
},
{
"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 among 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": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".example"
}]
},
{
"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 [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 a 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": "integer64"
},
{
"code": "positiveInt"
},
{
"code": "unsignedInt"
},
{
"code": "Quantity"
}],
"condition": ["eld-5"],
"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 [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 a 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": "integer64"
},
{
"code": "positiveInt"
},
{
"code": "unsignedInt"
},
{
"code": "Quantity"
}],
"condition": ["eld-5"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.maxLength",
"path": "ElementDefinition.maxLength",
"short": "Max length for string type data",
"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. ```maxLength``` SHOULD only be used on primitive data types that have a string representation (see [http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics](http://hl7.org/fhir/extensions/StructureDefinition-structuredefinition-type-characteristics.html)).",
"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"
}],
"condition": ["eld-5"],
"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"
}],
"condition": ["eld-14"],
"constraint": [{
"key": "eld-21",
"severity": "warning",
"human": "Constraints should have an expression or else validators will not be able to enforce them",
"expression": "expression.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-26",
"severity": "error",
"human": "Errors cannot be suppressed",
"expression": "(severity = 'error') implies suppress.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
}],
"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 might not be intuitive to all implementers.",
"min": 0,
"max": "1",
"type": [{
"code": "markdown"
}],
"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"
}],
"condition": ["eld-26"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "SHALL applications comply with this constraint?"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConstraintSeverity"
}],
"strength": "required",
"description": "SHALL applications comply with this constraint?",
"valueSet": "http://hl7.org/fhir/ValueSet/constraint-severity|5.0.0"
},
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.constraint.suppress",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.constraint.suppress",
"short": "Suppress warning or hint in profile",
"definition": "If true, indicates that the warning or best practice guideline should be suppressed.",
"comment": "This element should only be present in a derived profile where a warning or hint has been determined to be spurious/incorrect. E.g. a warning encouraging the inclusion of an element that the profile explicitly prohibits.",
"min": 0,
"max": "1",
"type": [{
"code": "boolean"
}],
"condition": ["eld-26"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.constraint.human",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.",
"comment": "In the absense of an expression, the expression is likely not enforceable by validators, and might be missed by many systems.",
"requirements": "Used by validation tooling tests of the validity of the resource.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["eld-21"],
"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": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.mustHaveValue",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.mustHaveValue",
"short": "For primitives, that a value must be present - not replaced by an extension",
"definition": "Specifies for a primitive data type that the value of the data type cannot be replaced by an extension.",
"comment": "Typical extensions that can be provided in place of a the value are [http://hl7.org/fhir/StructureDefinition/data-absent-reason](http://hl7.org/fhir/extensions/StructureDefinition-data-absent-reason.html), [http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor](http://hl7.org/fhir/extensions/StructureDefinition-iso21090-nullFlavor.html), [http://hl7.org/fhir/StructureDefinition/originalText](http://hl7.org/fhir/extensions/StructureDefinition-originalText.html), and [http://hl7.org/fhir/StructureDefinition/cqf-expression](http://hl7.org/fhir/extensions/StructureDefinition-cqf-expression.html). Note that this element has no meaning when a value is provided, and extensions can be provided in addition to a value.",
"min": 0,
"max": "1",
"type": [{
"code": "boolean"
}],
"condition": ["eld-28"],
"isSummary": true
},
{
"id": "ElementDefinition.valueAlternatives",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.valueAlternatives",
"short": "Extensions that are allowed to replace a primitive value",
"definition": "Specifies a list of extensions that can appear in place of a primitive value.",
"comment": "if mustHaveValue is true, then this element should not be present, since no extensions are allowed in place of the value. Note that this element has no impact if the value is present.",
"min": 0,
"max": "*",
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"meaningWhenMissing": "If this element is missing, then any extension can be used if its context is appropriate",
"condition": ["eld-28"],
"isSummary": true
},
{
"id": "ElementDefinition.mustSupport",
"path": "ElementDefinition.mustSupport",
"short": "If the element must be supported (discouraged - see obligations)",
"definition": "If true, implementations that produce or consume resources SHALL provide \"support\" for the element in some meaningful way. Note that this is being phased out and replaced by obligations (see below). If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.",
"comment": "\"Something meaningful\" is context dependent and impossible to describe in the base FHIR specification. For this reason, the mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. A profile on a type can always make mustSupport = true if it is false in the base type but cannot make mustSupport = false if it is true in the base type. This 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. Note 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"
}],
"meaningWhenMissing": "In a base type, where the element is being defined for the first time, the element is assumed to be mustSupport = false. In a profile (a constraint on an existing type), if mustSupport is not specific in either the differential or the snapshot, the mustSupport value is not changed from the base definition. Note, though, that the snapshot SHOULD always populate the mustSupport value",
"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. When used on the root element in an extension definition, this indicates whether or not the extension is a modifier extension.",
"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 (except in the special case of the defining a new extension). 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"
}],
"meaningWhenMissing": "An element is not a modifier element unless it is explicitly specified to be one",
"condition": ["eld-18"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": "??"
}]
},
{
"id": "ElementDefinition.isModifierReason",
"path": "ElementDefinition.isModifierReason",
"short": "Reason that this element is marked as a modifier",
"definition": "Explains how that element affects the interpretation of the resource or element that contains it.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["eld-18"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"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. When a request is made with _summary=true, serializers only include elements marked as 'isSummary = true'. With a few exceptions (listed below), all datatype properties are included in the summary form. In resource and datatype definitions, if an element has a descendant marked as isSummary=true or if it satisfies both of the following conditions, it must be marked as isSummary=true:\n* is at the root or has a parent that is 'mustSupport'\n* has a minimum cardinality of 1 or is a modifier element\n\nThe following datatype properties are exceptions, and are not marked as isSummary:\n* Attachment.data\n* Signature.data, Signature.targetFormat, Signature.sigFormat\n* Narrative.status, Narrative.div\n* SampledData.data.",
"requirements": "Allow clients to search through large resources quickly.",
"min": 0,
"max": "1",
"type": [{
"code": "boolean"
}],
"meaningWhenMissing": "An element is not included in the summary unless it is explicitly specified to be so",
"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",
"eld-5"],
"constraint": [{
"key": "eld-23",
"severity": "error",
"human": "binding SHALL have either description or valueSet",
"expression": "description.exists() or valueSet.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
},
{
"key": "eld-12",
"severity": "error",
"human": "ValueSet SHALL start with http:// or https:// or urn: or #",
"expression": "valueSet.exists() implies (valueSet.startsWith('http:') or valueSet.startsWith('https') or valueSet.startsWith('urn:') or valueSet.startsWith('#'))",
"source": "http://hl7.org/fhir/StructureDefinition/ElementDefinition"
}],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "OM3, OMC.11"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain"
}]
},
{
"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/tools/StructureDefinition/binding-definition",
"valueString": "Indication of the degree of conformance expectations associated with a binding."
},
{
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/binding-strength|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
},
{
"id": "ElementDefinition.binding.description",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}],
"path": "ElementDefinition.binding.description",
"short": "Intended use of codes in the bound value set",
"definition": "Describes the intended use of this particular set of codes.",
"min": 0,
"max": "1",
"type": [{
"code": "markdown"
}],
"condition": ["eld-23"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
},
{
"identity": "iso11179",
"map": ".domain.description"
}]
},
{
"id": "ElementDefinition.binding.valueSet",
"path": "ElementDefinition.binding.valueSet",
"short": "Source of value set",
"definition": "Refers to the value set that identifies the set of codes the binding refers to.",
"comment": "The reference may be version-specific or not (e.g. have a |[version] at the end of the canonical URL).",
"min": 0,
"max": "1",
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"condition": ["eld-12",
"eld-23"],
"isSummary": true,
"mapping": [{
"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": "dex",
"map": "valueDomain.valueSet"
}]
},
{
"id": "ElementDefinition.binding.additional",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ElementDefinition.binding.additional",
"short": "Additional Bindings - more rules about the binding",
"definition": "Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.",
"min": 0,
"max": "*",
"type": [{
"code": "Element"
}],
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.purpose",
"path": "ElementDefinition.binding.additional.purpose",
"short": "maximum | minimum | required | extensible | candidate | current | preferred | ui | starter | component",
"definition": "The use of this additional binding.",
"comment": "Conformance bindings are in addition to the base binding, not instead of it.",
"min": 1,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The use of an additional binding."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdditionalBindingPurpose"
}],
"strength": "required",
"description": "The use of an additional binding.",
"valueSet": "http://hl7.org/fhir/ValueSet/additional-binding-purpose|5.0.0"
}
},
{
"id": "ElementDefinition.binding.additional.valueSet",
"path": "ElementDefinition.binding.additional.valueSet",
"short": "The value set for the additional binding",
"definition": "The valueSet that is being bound for the purpose.",
"min": 1,
"max": "1",
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.documentation",
"path": "ElementDefinition.binding.additional.documentation",
"short": "Documentation of the purpose of use of the binding",
"definition": "Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.",
"min": 0,
"max": "1",
"type": [{
"code": "markdown"
}],
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.shortDoco",
"path": "ElementDefinition.binding.additional.shortDoco",
"short": "Concise documentation - for summary tables",
"definition": "Concise documentation - for summary tables.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.usage",
"path": "ElementDefinition.binding.additional.usage",
"short": "Qualifies the usage - jurisdiction, gender, workflow status etc.",
"definition": "Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.",
"comment": "This specification does not define exactly how the context is determined for the usage; typically, this will be described in implementation guides.",
"min": 0,
"max": "*",
"type": [{
"code": "UsageContext"
}],
"isSummary": true
},
{
"id": "ElementDefinition.binding.additional.any",
"path": "ElementDefinition.binding.additional.any",
"short": "Whether binding can applies to all repeats, or just one",
"definition": "Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.",
"comment": "A common pattern is to make a conformance binding to all repeats, and then make a binding that one of the repeats must conform to.",
"min": 0,
"max": "1",
"type": [{
"code": "boolean"
}],
"isSummary": true
},
{
"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"
}],
"condition": ["eld-27"],
"isSummary": true,
"mapping": [{
"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)"
},
{
"identity": "dex",
"map": "mappingSpecification"
}]
},
{
"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"
}],
"condition": ["eld-27"],
"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/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"
},
"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": "markdown"
}],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (MIF territory)"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Expression",
"resource": {
"resourceType": "StructureDefinition",
"id": "Expression",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Expression ΣTU Element An expression that can be used to generate a value
+ Rule: An expression or a reference must be provided
+ Rule: The name must be a valid variable name in most computer languages
Elements defined in Ancestors: id, extension description Σ 0..1 string Natural language description of the condition
name ΣC 0..1 code Short name assigned to expression for reuse
language Σ 0..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: Expression Language (Extensible)Additional Bindings Purpose Mime Types Max Binding
expression ΣC 0..1 string Expression in specified language
reference ΣC 0..1 uri Where the expression is found
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Expression",
"version": "5.0.0",
"name": "Expression",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Expression Type: A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Expression",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Expression",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Expression",
"short": "An expression that can be used to generate a value",
"definition": "A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.",
"min": 0,
"max": "*",
"base": {
"path": "Expression",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "exp-1",
"severity": "error",
"human": "An expression or a reference must be provided",
"expression": "expression.exists() or reference.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Expression"
},
{
"key": "exp-2",
"severity": "error",
"human": "The name must be a valid variable name in most computer languages",
"expression": "name.hasValue() implies name.matches('[A-Za-z][A-Za-z0-9\\\\_]{0,63}')",
"source": "http://hl7.org/fhir/StructureDefinition/Expression"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Expression.id",
"path": "Expression.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Expression.extension",
"path": "Expression.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Expression.description",
"path": "Expression.description",
"short": "Natural language description of the condition",
"definition": "A brief, natural language description of the condition that effectively communicates the intended semantics.",
"min": 0,
"max": "1",
"base": {
"path": "Expression.description",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Expression.name",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"path": "Expression.name",
"short": "Short name assigned to expression for reuse",
"definition": "A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.",
"min": 0,
"max": "1",
"base": {
"path": "Expression.name",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["exp-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Expression.language",
"path": "Expression.language",
"short": "text/cql | text/fhirpath | application/x-fhir-query | etc.",
"definition": "The media type of the language for the expression.",
"requirements": "The cardinality of this element is optional to allow text only as part of the authoring process. However, in order to be executable, the expression element must be specified.",
"min": 0,
"max": "1",
"base": {
"path": "Expression.language",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The media type of the expression language."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ExpressionLanguage"
}],
"strength": "extensible",
"description": "The media type of the expression language.",
"valueSet": "http://hl7.org/fhir/ValueSet/expression-language",
"additional": [{
"purpose": "maximum",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes"
}]
}
},
{
"id": "Expression.expression",
"path": "Expression.expression",
"short": "Expression in specified language",
"definition": "An expression in the specified language that returns a value.",
"comment": "If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.",
"min": 0,
"max": "1",
"base": {
"path": "Expression.expression",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["exp-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Expression.reference",
"path": "Expression.reference",
"short": "Where the expression is found",
"definition": "A URI that defines where the expression is found.",
"comment": "If both a reference and an expression is found, the reference SHALL point to the same expression.",
"min": 0,
"max": "1",
"base": {
"path": "Expression.reference",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"condition": ["exp-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "Expression",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Expression",
"short": "An expression that can be used to generate a value",
"definition": "A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.",
"min": 0,
"max": "*",
"constraint": [{
"key": "exp-2",
"severity": "error",
"human": "The name must be a valid variable name in most computer languages",
"expression": "name.hasValue() implies name.matches('[A-Za-z][A-Za-z0-9\\\\_]{0,63}')",
"source": "http://hl7.org/fhir/StructureDefinition/Expression"
},
{
"key": "exp-1",
"severity": "error",
"human": "An expression or a reference must be provided",
"expression": "expression.exists() or reference.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Expression"
}]
},
{
"id": "Expression.description",
"path": "Expression.description",
"short": "Natural language description of the condition",
"definition": "A brief, natural language description of the condition that effectively communicates the intended semantics.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
},
{
"id": "Expression.name",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"path": "Expression.name",
"short": "Short name assigned to expression for reuse",
"definition": "A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"condition": ["exp-2"],
"isSummary": true
},
{
"id": "Expression.language",
"path": "Expression.language",
"short": "text/cql | text/fhirpath | application/x-fhir-query | etc.",
"definition": "The media type of the language for the expression.",
"requirements": "The cardinality of this element is optional to allow text only as part of the authoring process. However, in order to be executable, the expression element must be specified.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The media type of the expression language."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ExpressionLanguage"
}],
"strength": "extensible",
"description": "The media type of the expression language.",
"valueSet": "http://hl7.org/fhir/ValueSet/expression-language",
"additional": [{
"purpose": "maximum",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes"
}]
}
},
{
"id": "Expression.expression",
"path": "Expression.expression",
"short": "Expression in specified language",
"definition": "An expression in the specified language that returns a value.",
"comment": "If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["exp-1"],
"isSummary": true
},
{
"id": "Expression.reference",
"path": "Expression.reference",
"short": "Where the expression is found",
"definition": "A URI that defines where the expression is found.",
"comment": "If both a reference and an expression is found, the reference SHALL point to the same expression.",
"min": 0,
"max": "1",
"type": [{
"code": "uri"
}],
"condition": ["exp-1"],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/ExtendedContactDetail",
"resource": {
"resourceType": "StructureDefinition",
"id": "ExtendedContactDetail",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints ExtendedContactDetail ΣTU Element Contact information
Elements defined in Ancestors: id, extension purpose Σ 0..1 CodeableConcept The type of contact
Binding: Contact entity type (Preferred)
name Σ 0..* HumanName Name of an individual to contact
telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)
address Σ 0..1 Address Address for the contact
organization Σ 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization
period Σ 0..1 Period Period that this contact was valid for usage
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/ExtendedContactDetail",
"version": "5.0.0",
"name": "ExtendedContactDetail",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "ExtendedContactDetail Type: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to track contact and address information in the same way across multiple resources.",
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "ExtendedContactDetail",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "ExtendedContactDetail",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ExtendedContactDetail",
"short": "Contact information",
"definition": "Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.",
"comment": "This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out.",
"min": 0,
"max": "*",
"base": {
"path": "ExtendedContactDetail",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ExtendedContactDetail.id",
"path": "ExtendedContactDetail.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ExtendedContactDetail.extension",
"path": "ExtendedContactDetail.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ExtendedContactDetail.purpose",
"path": "ExtendedContactDetail.purpose",
"short": "The type of contact",
"definition": "The purpose/type of contact.",
"comment": "If no purpose is defined, then these contact details may be used for any purpose.",
"min": 0,
"max": "1",
"base": {
"path": "ExtendedContactDetail.purpose",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Purpose"
}],
"strength": "preferred",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://terminology.hl7.org/ValueSet/contactentity-type"
}
},
{
"id": "ExtendedContactDetail.name",
"path": "ExtendedContactDetail.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact, some types of contact detail are usually blank.",
"comment": "If there is no named individual, the telecom/address information is not generally monitored by a specific individual.",
"min": 0,
"max": "*",
"base": {
"path": "ExtendedContactDetail.name",
"min": 0,
"max": "*"
},
"type": [{
"code": "HumanName"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ExtendedContactDetail.telecom",
"path": "ExtendedContactDetail.telecom",
"short": "Contact details (e.g.phone/fax/url)",
"definition": "The contact details application for the purpose defined.",
"min": 0,
"max": "*",
"base": {
"path": "ExtendedContactDetail.telecom",
"min": 0,
"max": "*"
},
"type": [{
"code": "ContactPoint"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ExtendedContactDetail.address",
"path": "ExtendedContactDetail.address",
"short": "Address for the contact",
"definition": "Address for the contact.",
"comment": "More than 1 address would be for different purposes, and thus should be entered as a different entry,.",
"min": 0,
"max": "1",
"base": {
"path": "ExtendedContactDetail.address",
"min": 0,
"max": "1"
},
"type": [{
"code": "Address"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ExtendedContactDetail.organization",
"path": "ExtendedContactDetail.organization",
"short": "This contact detail is handled/monitored by a specific organization",
"definition": "This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.",
"requirements": "Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).",
"min": 0,
"max": "1",
"base": {
"path": "ExtendedContactDetail.organization",
"min": 0,
"max": "1"
},
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ExtendedContactDetail.period",
"path": "ExtendedContactDetail.period",
"short": "Period that this contact was valid for usage",
"definition": "Period that this contact was valid for usage.",
"comment": "If the details have multiple periods, then enter in a new ExtendedContact with the new period.",
"min": 0,
"max": "1",
"base": {
"path": "ExtendedContactDetail.period",
"min": 0,
"max": "1"
},
"type": [{
"code": "Period"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "ExtendedContactDetail",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "ExtendedContactDetail",
"short": "Contact information",
"definition": "Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.",
"comment": "This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out.",
"min": 0,
"max": "*"
},
{
"id": "ExtendedContactDetail.purpose",
"path": "ExtendedContactDetail.purpose",
"short": "The type of contact",
"definition": "The purpose/type of contact.",
"comment": "If no purpose is defined, then these contact details may be used for any purpose.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Purpose"
}],
"strength": "preferred",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://terminology.hl7.org/ValueSet/contactentity-type"
}
},
{
"id": "ExtendedContactDetail.name",
"path": "ExtendedContactDetail.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact, some types of contact detail are usually blank.",
"comment": "If there is no named individual, the telecom/address information is not generally monitored by a specific individual.",
"min": 0,
"max": "*",
"type": [{
"code": "HumanName"
}],
"isSummary": true
},
{
"id": "ExtendedContactDetail.telecom",
"path": "ExtendedContactDetail.telecom",
"short": "Contact details (e.g.phone/fax/url)",
"definition": "The contact details application for the purpose defined.",
"min": 0,
"max": "*",
"type": [{
"code": "ContactPoint"
}],
"isSummary": true
},
{
"id": "ExtendedContactDetail.address",
"path": "ExtendedContactDetail.address",
"short": "Address for the contact",
"definition": "Address for the contact.",
"comment": "More than 1 address would be for different purposes, and thus should be entered as a different entry,.",
"min": 0,
"max": "1",
"type": [{
"code": "Address"
}],
"isSummary": true
},
{
"id": "ExtendedContactDetail.organization",
"path": "ExtendedContactDetail.organization",
"short": "This contact detail is handled/monitored by a specific organization",
"definition": "This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.",
"requirements": "Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).",
"min": 0,
"max": "1",
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary": true
},
{
"id": "ExtendedContactDetail.period",
"path": "ExtendedContactDetail.period",
"short": "Period that this contact was valid for usage",
"definition": "Period that this contact was valid for usage.",
"comment": "If the details have multiple periods, then enter in a new ExtendedContact with the new period.",
"min": 0,
"max": "1",
"type": [{
"code": "Period"
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Extension",
"resource": {
"resourceType": "StructureDefinition",
"id": "Extension",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Extension N Element Optional Extensions Element
+ Rule: Must have either extensions or value[x], not both
Elements defined in Ancestors: id, extension url 1..1 uri identifies the meaning of the extension
value[x] C 0..1 * Value of extension
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Extension",
"version": "5.0.0",
"name": "Extension",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Extension Type: Optional Extension Element - found in all resources.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "The ability to add extensions in a structured way is what keeps FHIR resources simple.",
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Extension",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Extension",
"short": "Optional Extensions Element",
"definition": "Optional Extension Element - found in all resources.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,N/A"
}]
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": ["xmlAttr"],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["ext-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
},
"differential": {
"element": [{
"id": "Extension",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Extension",
"short": "Optional Extensions Element",
"definition": "Optional Extension Element - found in all resources.",
"min": 0,
"max": "*",
"constraint": [{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": ["xmlAttr"],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"min": 0,
"max": "1",
"type": [{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}],
"condition": ["ext-1"],
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/HumanName",
"resource": {
"resourceType": "StructureDefinition",
"id": "HumanName",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints HumanName ΣN Element Name of a human or other living entity - parts and usage
Elements defined in Ancestors: id, extension use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (Required)
text Σ 0..1 string Text representation of the full name
family Σ 0..1 string Family name (often called 'Surname')
given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
period Σ 0..1 Period Time period when name was/is in use
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/HumanName",
"version": "5.0.0",
"name": "HumanName",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "HumanName Type: A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to be able to record names, along with notes about their use.",
"fhirVersion": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "HumanName",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "HumanName",
"short": "Name of a human or other living entity - parts and usage",
"definition": "A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.",
"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 might or might 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": "*",
"base": {
"path": "HumanName",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,EN (actually, PN)"
},
{
"identity": "v2",
"map": "XPN"
},
{
"identity": "servd",
"map": "ProviderName"
}]
},
{
"id": "HumanName.id",
"path": "HumanName.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "HumanName.use",
"path": "HumanName.use",
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"definition": "Identifies the purpose for this name.",
"comment": "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",
"base": {
"path": "HumanName.use",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The use of a human name."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
}],
"strength": "required",
"description": "The use of a human name.",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use|5.0.0"
},
"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": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.",
"comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"requirements": "A renderable, unencoded form.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.text",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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",
"base": {
"path": "HumanName.family",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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 parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.",
"alias": ["first name",
"middle name"],
"min": 0,
"max": "*",
"base": {
"path": "HumanName.given",
"min": 0,
"max": "*"
},
"type": [{
"code": "string"
}],
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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": "*",
"base": {
"path": "HumanName.prefix",
"min": 0,
"max": "*"
},
"type": [{
"code": "string"
}],
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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": "*",
"base": {
"path": "HumanName.suffix",
"min": 0,
"max": "*"
},
"type": [{
"code": "string"
}],
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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",
"base": {
"path": "HumanName.period",
"min": 0,
"max": "1"
},
"type": [{
"code": "Period"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "HumanName",
"short": "Name of a human or other living entity - parts and usage",
"definition": "A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.",
"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 might or might 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": "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,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The use of a human name."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
}],
"strength": "required",
"description": "The use of a human name.",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use|5.0.0"
},
"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": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.",
"comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"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 parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is 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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Identifier ΣN Element An identifier intended for computation
+ Warning: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
Elements defined in Ancestors: id, extension use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (Required)
type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (Extensible)
system Σ 0..1 uri The namespace for the identifier value
value ΣC 0..1 string The value that is unique
period Σ 0..1 Period Time period when id is/was valid for use
assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Identifier",
"version": "5.0.0",
"name": "Identifier",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation.",
"fhirVersion": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Identifier",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Identifier",
"short": "An identifier intended for computation",
"definition": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"comment": "The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.",
"min": 0,
"max": "*",
"base": {
"path": "Identifier",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ident-1",
"severity": "warning",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"expression": "value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,II - 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": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "servd",
"map": "Identifier"
}]
},
{
"id": "Identifier.id",
"path": "Identifier.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Identifier.use",
"path": "Identifier.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "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",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Identifies the purpose for this identifier, if known ."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|5.0.0"
},
"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. Where 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",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
{
"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.",
"valueSet": "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, an absolute URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"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",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"example": [{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"example": [{
"label": "General",
"valueString": "123456"
}],
"condition": ["ident-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [{
"code": "Period"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Identifier",
"short": "An identifier intended for computation",
"definition": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"comment": "The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.",
"min": 0,
"max": "*",
"constraint": [{
"key": "ident-1",
"severity": "warning",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"expression": "value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier"
}],
"mapping": [{
"identity": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "rim",
"map": "II - 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 | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "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,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Identifies the purpose for this identifier, if known ."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|5.0.0"
},
"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. Where 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/tools/StructureDefinition/binding-definition",
"valueString": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
{
"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.",
"valueSet": "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, an absolute URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"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"
}],
"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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"example": [{
"label": "General",
"valueString": "123456"
}],
"condition": ["ident-1"],
"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/MarketingStatus",
"resource": {
"resourceType": "StructureDefinition",
"id": "MarketingStatus",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints MarketingStatus ΣD Element The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available
Elements defined in Ancestors: id, extension, modifierExtension country Σ 0..1 CodeableConcept The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
jurisdiction Σ 0..1 CodeableConcept Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
status Σ 1..1 CodeableConcept This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
dateRange Σ 0..1 Period The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
restoreDate Σ 0..1 dateTime The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"url": "http://hl7.org/fhir/StructureDefinition/MarketingStatus",
"version": "5.0.0",
"name": "MarketingStatus",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "MarketingStatus Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "MarketingStatus",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/BackboneType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "MarketingStatus",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"path": "MarketingStatus",
"short": "The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available",
"definition": "The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.",
"min": 0,
"max": "*",
"base": {
"path": "MarketingStatus",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "administrative.medication"
}]
},
{
"id": "MarketingStatus.id",
"path": "MarketingStatus.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "MarketingStatus.extension",
"path": "MarketingStatus.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "MarketingStatus.modifierExtension",
"path": "MarketingStatus.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": ["extensions",
"user content",
"modifiers"],
"min": 0,
"max": "*",
"base": {
"path": "BackboneType.modifierExtension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "MarketingStatus.country",
"path": "MarketingStatus.country",
"short": "The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements",
"definition": "The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements.",
"min": 0,
"max": "1",
"base": {
"path": "MarketingStatus.country",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "MarketingStatus.jurisdiction",
"path": "MarketingStatus.jurisdiction",
"short": "Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified",
"definition": "Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.",
"min": 0,
"max": "1",
"base": {
"path": "MarketingStatus.jurisdiction",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "MarketingStatus.status",
"path": "MarketingStatus.status",
"short": "This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples",
"definition": "This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.",
"min": 1,
"max": "1",
"base": {
"path": "MarketingStatus.status",
"min": 1,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "MarketingStatus.dateRange",
"path": "MarketingStatus.dateRange",
"short": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain",
"definition": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.",
"min": 0,
"max": "1",
"base": {
"path": "MarketingStatus.dateRange",
"min": 0,
"max": "1"
},
"type": [{
"code": "Period"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "MarketingStatus.restoreDate",
"path": "MarketingStatus.restoreDate",
"short": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain",
"definition": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.",
"min": 0,
"max": "1",
"base": {
"path": "MarketingStatus.restoreDate",
"min": 0,
"max": "1"
},
"type": [{
"code": "dateTime"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "MarketingStatus",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"path": "MarketingStatus",
"short": "The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available",
"definition": "The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "w5",
"map": "administrative.medication"
}]
},
{
"id": "MarketingStatus.country",
"path": "MarketingStatus.country",
"short": "The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements",
"definition": "The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true
},
{
"id": "MarketingStatus.jurisdiction",
"path": "MarketingStatus.jurisdiction",
"short": "Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified",
"definition": "Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true
},
{
"id": "MarketingStatus.status",
"path": "MarketingStatus.status",
"short": "This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples",
"definition": "This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.",
"min": 1,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true
},
{
"id": "MarketingStatus.dateRange",
"path": "MarketingStatus.dateRange",
"short": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain",
"definition": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.",
"min": 0,
"max": "1",
"type": [{
"code": "Period"
}],
"isSummary": true
},
{
"id": "MarketingStatus.restoreDate",
"path": "MarketingStatus.restoreDate",
"short": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain",
"definition": "The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.",
"min": 0,
"max": "1",
"type": [{
"code": "dateTime"
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Meta",
"resource": {
"resourceType": "StructureDefinition",
"id": "Meta",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Meta ΣN Element Metadata about a resource
Elements defined in Ancestors: id, extension versionId Σ 0..1 id Version specific identifier
lastUpdated Σ 0..1 instant When the resource version last changed
source Σ 0..1 uri Identifies where the resource comes from
profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (Extensible)
tag Σ 0..* Coding Tags applied to this resource
Binding: Common Tags (Example)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Meta",
"version": "5.0.0",
"name": "Meta",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Meta Type: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Meta",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Meta",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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 might not always be associated with version changes to the resource.",
"min": 0,
"max": "*",
"base": {
"path": "Meta",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,N/A"
}]
},
{
"id": "Meta.id",
"path": "Meta.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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 value 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",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [{
"code": "id"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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 element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [{
"code": "instant"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Meta.source",
"path": "Meta.source",
"short": "Identifies where the resource comes from",
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"comment": "The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.source",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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](structuredefinition-definitions.html#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": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "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": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Security Labels from the Healthcare Privacy and Security Classification System."
},
{
"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.",
"valueSet": "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": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"."
},
{
"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\".",
"valueSet": "http://hl7.org/fhir/ValueSet/common-tags"
}
}]
},
"differential": {
"element": [{
"id": "Meta",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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 might 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 value 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 element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction.",
"min": 0,
"max": "1",
"type": [{
"code": "instant"
}],
"isSummary": true
},
{
"id": "Meta.source",
"path": "Meta.source",
"short": "Identifies where the resource comes from",
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"comment": "The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"min": 0,
"max": "1",
"type": [{
"code": "uri"
}],
"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](structuredefinition-definitions.html#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": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"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/tools/StructureDefinition/binding-definition",
"valueString": "Security Labels from the Healthcare Privacy and Security Classification System."
},
{
"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.",
"valueSet": "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/tools/StructureDefinition/binding-definition",
"valueString": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"."
},
{
"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\".",
"valueSet": "http://hl7.org/fhir/ValueSet/common-tags"
}
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/MonetaryComponent",
"resource": {
"resourceType": "StructureDefinition",
"id": "MonetaryComponent",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints MonetaryComponent ΣTU Element Availability data for an {item}
Elements defined in Ancestors: id, extension type Σ 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: Price Component Type (Required)
code Σ 0..1 CodeableConcept Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
factor Σ 0..1 decimal Factor used for calculating this component
amount Σ 0..1 Money Explicit value amount to be used
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}],
"url": "http://hl7.org/fhir/StructureDefinition/MonetaryComponent",
"version": "5.0.0",
"name": "MonetaryComponent",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "MonetaryComponent Type: Availability data for an {item}.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "MonetaryComponent",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "MonetaryComponent",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "MonetaryComponent",
"short": "Availability data for an {item}",
"definition": "Availability data for an {item}.",
"min": 0,
"max": "*",
"base": {
"path": "MonetaryComponent",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "MonetaryComponent.id",
"path": "MonetaryComponent.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "MonetaryComponent.extension",
"path": "MonetaryComponent.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "MonetaryComponent.type",
"path": "MonetaryComponent.type",
"short": "base | surcharge | deduction | discount | tax | informational",
"definition": "base | surcharge | deduction | discount | tax | informational.",
"min": 1,
"max": "1",
"base": {
"path": "MonetaryComponent.type",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentType"
}],
"strength": "required",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://hl7.org/fhir/ValueSet/price-component-type|5.0.0"
}
},
{
"id": "MonetaryComponent.code",
"path": "MonetaryComponent.code",
"short": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"definition": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min": 0,
"max": "1",
"base": {
"path": "MonetaryComponent.code",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentCode"
}],
"strength": "example",
"description": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
}
},
{
"id": "MonetaryComponent.factor",
"path": "MonetaryComponent.factor",
"short": "Factor used for calculating this component",
"definition": "Factor used for calculating this component.",
"min": 0,
"max": "1",
"base": {
"path": "MonetaryComponent.factor",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "MonetaryComponent.amount",
"path": "MonetaryComponent.amount",
"short": "Explicit value amount to be used",
"definition": "Explicit value amount to be used.",
"min": 0,
"max": "1",
"base": {
"path": "MonetaryComponent.amount",
"min": 0,
"max": "1"
},
"type": [{
"code": "Money"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "MonetaryComponent",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "MonetaryComponent",
"short": "Availability data for an {item}",
"definition": "Availability data for an {item}.",
"min": 0,
"max": "*"
},
{
"id": "MonetaryComponent.type",
"path": "MonetaryComponent.type",
"short": "base | surcharge | deduction | discount | tax | informational",
"definition": "base | surcharge | deduction | discount | tax | informational.",
"min": 1,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentType"
}],
"strength": "required",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://hl7.org/fhir/ValueSet/price-component-type|5.0.0"
}
},
{
"id": "MonetaryComponent.code",
"path": "MonetaryComponent.code",
"short": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"definition": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentCode"
}],
"strength": "example",
"description": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
}
},
{
"id": "MonetaryComponent.factor",
"path": "MonetaryComponent.factor",
"short": "Factor used for calculating this component",
"definition": "Factor used for calculating this component.",
"min": 0,
"max": "1",
"type": [{
"code": "decimal"
}],
"isSummary": true
},
{
"id": "MonetaryComponent.amount",
"path": "MonetaryComponent.amount",
"short": "Explicit value amount to be used",
"definition": "Explicit value amount to be used.",
"min": 0,
"max": "1",
"type": [{
"code": "Money"
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Money",
"resource": {
"resourceType": "StructureDefinition",
"id": "Money",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Money ΣN Element An amount of economic utility in some recognized currency
Elements defined in Ancestors: id, extension value Σ 0..1 decimal Numerical value (with implicit precision)
currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (Required)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Money",
"version": "5.0.0",
"name": "Money",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Money Type: An amount of economic utility in some recognized currency.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Money",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Money",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Money",
"short": "An amount of economic utility in some recognized currency",
"definition": "An amount of economic utility in some recognized currency.",
"min": 0,
"max": "*",
"base": {
"path": "Money",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,MO"
}]
},
{
"id": "Money.id",
"path": "Money.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Money.value",
"path": "Money.value",
"short": "Numerical value (with implicit precision)",
"definition": "Numerical value (with implicit precision).",
"comment": "Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"requirements": "The amount of the currency. The value includes an implicit precision in the presentation of the value.",
"min": 0,
"max": "1",
"base": {
"path": "Money.value",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "MO.Value"
}]
},
{
"id": "Money.currency",
"path": "Money.currency",
"short": "ISO 4217 Currency Code",
"definition": "ISO 4217 Currency Code.",
"requirements": "A code indicating the currency, taken from ISO 4217.",
"min": 0,
"max": "1",
"base": {
"path": "Money.currency",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A code indicating the currency, taken from ISO 4217."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CurrencyCode"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "A code indicating the currency, taken from ISO 4217.",
"valueSet": "http://hl7.org/fhir/ValueSet/currencies|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "MO.Currency"
}]
}]
},
"differential": {
"element": [{
"id": "Money",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Money",
"short": "An amount of economic utility in some recognized currency",
"definition": "An amount of economic utility in some recognized currency.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "rim",
"map": "MO"
}]
},
{
"id": "Money.value",
"path": "Money.value",
"short": "Numerical value (with implicit precision)",
"definition": "Numerical value (with implicit precision).",
"comment": "Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"requirements": "The amount of the currency. The value includes an implicit precision in the presentation of the value.",
"min": 0,
"max": "1",
"type": [{
"code": "decimal"
}],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "MO.Value"
}]
},
{
"id": "Money.currency",
"path": "Money.currency",
"short": "ISO 4217 Currency Code",
"definition": "ISO 4217 Currency Code.",
"requirements": "A code indicating the currency, taken from ISO 4217.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A code indicating the currency, taken from ISO 4217."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CurrencyCode"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "A code indicating the currency, taken from ISO 4217.",
"valueSet": "http://hl7.org/fhir/ValueSet/currencies|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "MO.Currency"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Narrative",
"resource": {
"resourceType": "StructureDefinition",
"id": "Narrative",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Narrative N Element Human-readable summary of the resource (essential clinical and business information)
Elements defined in Ancestors: id, extension status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (Required)
div C 1..1 xhtml Limited xhtml content
+ Rule: 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
+ Rule: The narrative SHALL have some non-whitespace content
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Narrative",
"version": "5.0.0",
"name": "Narrative",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Narrative",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Narrative",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Narrative",
"short": "Human-readable summary of the resource (essential clinical and business information)",
"definition": "A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
"min": 0,
"max": "*",
"base": {
"path": "Narrative",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,N/A"
}]
},
{
"id": "Narrative.id",
"path": "Narrative.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Narrative.status",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The status of a resource narrative."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
}],
"strength": "required",
"description": "The status of a resource narrative.",
"valueSet": "http://hl7.org/fhir/ValueSet/narrative-status|5.0.0"
},
"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 SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.div",
"min": 1,
"max": "1"
},
"type": [{
"code": "xhtml"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/Narrative"
},
{
"key": "txt-2",
"severity": "error",
"human": "The narrative SHALL have some non-whitespace content",
"expression": "htmlChecks()",
"source": "http://hl7.org/fhir/StructureDefinition/Narrative"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
},
"differential": {
"element": [{
"id": "Narrative",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "Narrative",
"short": "Human-readable summary of the resource (essential clinical and business information)",
"definition": "A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
"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/tools/StructureDefinition/binding-definition",
"valueString": "The status of a resource narrative."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
}],
"strength": "required",
"description": "The status of a resource narrative.",
"valueSet": "http://hl7.org/fhir/ValueSet/narrative-status|5.0.0"
},
"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 SHALL 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()",
"source": "http://hl7.org/fhir/StructureDefinition/Narrative"
},
{
"key": "txt-2",
"severity": "error",
"human": "The narrative SHALL have some non-whitespace content",
"expression": "htmlChecks()",
"source": "http://hl7.org/fhir/StructureDefinition/Narrative"
}],
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/ParameterDefinition",
"resource": {
"resourceType": "StructureDefinition",
"id": "ParameterDefinition",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints ParameterDefinition ΣTU Element Definition of a parameter to a module
Elements defined in Ancestors: id, extension name Σ 0..1 code Name used to access the parameter value
use Σ 1..1 code in | out
Binding: Operation Parameter Use (Required)
min Σ 0..1 integer Minimum cardinality
max Σ 0..1 string Maximum cardinality (a number of *)
documentation Σ 0..1 string A brief description of the parameter
type Σ 1..1 code What type of value
Binding: All FHIR Types (Required)
profile Σ 0..1 canonical(StructureDefinition) What profile the value is expected to be
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/ParameterDefinition",
"version": "5.0.0",
"name": "ParameterDefinition",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "ParameterDefinition Type: 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.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "ParameterDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "ParameterDefinition",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "ParameterDefinition",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ParameterDefinition.id",
"path": "ParameterDefinition.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ParameterDefinition.name",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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",
"base": {
"path": "ParameterDefinition.name",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": 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",
"base": {
"path": "ParameterDefinition.use",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Whether the parameter is input or output."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParameterUse"
}],
"strength": "required",
"description": "Whether the parameter is input or output.",
"valueSet": "http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0"
}
},
{
"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",
"base": {
"path": "ParameterDefinition.min",
"min": 0,
"max": "1"
},
"type": [{
"code": "integer"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "ParameterDefinition.max",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"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",
"base": {
"path": "ParameterDefinition.documentation",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ParameterDefinition.type",
"path": "ParameterDefinition.type",
"short": "What type of value",
"definition": "The type of the parameter.",
"min": 1,
"max": "1",
"base": {
"path": "ParameterDefinition.type",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "List of FHIR types (resources, data types)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "List of FHIR types (resources, data types).",
"valueSet": "http://hl7.org/fhir/ValueSet/fhir-types|5.0.0"
}
},
{
"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",
"base": {
"path": "ParameterDefinition.profile",
"min": 0,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "ParameterDefinition",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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/tools/StructureDefinition/binding-definition",
"valueString": "Whether the parameter is input or output."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParameterUse"
}],
"strength": "required",
"description": "Whether the parameter is input or output.",
"valueSet": "http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0"
}
},
{
"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/tools/StructureDefinition/binding-definition",
"valueString": "List of FHIR types (resources, data types)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "List of FHIR types (resources, data types).",
"valueSet": "http://hl7.org/fhir/ValueSet/fhir-types|5.0.0"
}
},
{
"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": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Period",
"resource": {
"resourceType": "StructureDefinition",
"id": "Period",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Period ΣN Element Time range defined by start and end date/time
+ Rule: If present, start SHALL have a lower or equal value than end
Elements defined in Ancestors: id, extension start ΣC 0..1 dateTime Starting time with inclusive boundary
end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Period",
"version": "5.0.0",
"name": "Period",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Period Type: A time period defined by a start and end date and optionally time.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Period",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min": 0,
"max": "*",
"base": {
"path": "Period",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower or equal value than end",
"expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())",
"source": "http://hl7.org/fhir/StructureDefinition/Period"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity": "v2",
"map": "DR"
}]
},
{
"id": "Period.id",
"path": "Period.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Period.start",
"min": 0,
"max": "1"
},
"type": [{
"code": "dateTime"
}],
"condition": ["per-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "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 no end was known or planned at the time the instance was created. 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 end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
"min": 0,
"max": "1",
"base": {
"path": "Period.end",
"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"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "DR.2"
},
{
"identity": "rim",
"map": "./high"
}]
}]
},
"differential": {
"element": [{
"id": "Period",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min": 0,
"max": "*",
"constraint": [{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower or equal value than end",
"expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())",
"source": "http://hl7.org/fhir/StructureDefinition/Period"
}],
"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 no end was known or planned at the time the instance was created. 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 end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an 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/PrimitiveType",
"resource": {
"resourceType": "StructureDefinition",
"id": "PrimitiveType",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints PrimitiveType «A»N DataType Parent type for DataTypes with a simple value
Elements defined in Ancestors: id, extension
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/PrimitiveType",
"version": "5.0.0",
"name": "PrimitiveType",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "PrimitiveType Type: The base type for all re-useable types defined that have a simple property.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": true,
"type": "PrimitiveType",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "PrimitiveType",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "PrimitiveType",
"short": "Parent type for DataTypes with a simple value",
"definition": "The base type for all re-useable types defined that have a simple property.",
"min": 0,
"max": "*",
"base": {
"path": "PrimitiveType",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "PrimitiveType.id",
"path": "PrimitiveType.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "PrimitiveType.extension",
"path": "PrimitiveType.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
}]
},
"differential": {
"element": [{
"id": "PrimitiveType",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "PrimitiveType",
"short": "Parent type for DataTypes with a simple value",
"definition": "The base type for all re-useable types defined that have a simple property.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/ProductShelfLife",
"resource": {
"resourceType": "StructureDefinition",
"id": "ProductShelfLife",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints ProductShelfLife ΣD Element The shelf-life and storage information for a medicinal product item or container can be described using this class
Elements defined in Ancestors: id, extension, modifierExtension type Σ 0..1 CodeableConcept This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
period[x] Σ 0..1 The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
periodDuration Duration periodString string specialPrecautionsForStorage Σ 0..* CodeableConcept Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"url": "http://hl7.org/fhir/StructureDefinition/ProductShelfLife",
"version": "5.0.0",
"name": "ProductShelfLife",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "ProductShelfLife",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/BackboneType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "ProductShelfLife",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"path": "ProductShelfLife",
"short": "The shelf-life and storage information for a medicinal product item or container can be described using this class",
"definition": "The shelf-life and storage information for a medicinal product item or container can be described using this class.",
"min": 0,
"max": "*",
"base": {
"path": "ProductShelfLife",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "administrative.medication"
}]
},
{
"id": "ProductShelfLife.id",
"path": "ProductShelfLife.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ProductShelfLife.extension",
"path": "ProductShelfLife.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "ProductShelfLife.modifierExtension",
"path": "ProductShelfLife.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": ["extensions",
"user content",
"modifiers"],
"min": 0,
"max": "*",
"base": {
"path": "BackboneType.modifierExtension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "ProductShelfLife.type",
"path": "ProductShelfLife.type",
"short": "This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified",
"definition": "This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.",
"min": 0,
"max": "1",
"base": {
"path": "ProductShelfLife.type",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ProductShelfLife.period[x]",
"path": "ProductShelfLife.period[x]",
"short": "The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used",
"definition": "The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.",
"min": 0,
"max": "1",
"base": {
"path": "ProductShelfLife.period[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "Duration"
},
{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "ProductShelfLife.specialPrecautionsForStorage",
"path": "ProductShelfLife.specialPrecautionsForStorage",
"short": "Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified",
"definition": "Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.",
"min": 0,
"max": "*",
"base": {
"path": "ProductShelfLife.specialPrecautionsForStorage",
"min": 0,
"max": "*"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "ProductShelfLife",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}],
"path": "ProductShelfLife",
"short": "The shelf-life and storage information for a medicinal product item or container can be described using this class",
"definition": "The shelf-life and storage information for a medicinal product item or container can be described using this class.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "w5",
"map": "administrative.medication"
}]
},
{
"id": "ProductShelfLife.type",
"path": "ProductShelfLife.type",
"short": "This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified",
"definition": "This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true
},
{
"id": "ProductShelfLife.period[x]",
"path": "ProductShelfLife.period[x]",
"short": "The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used",
"definition": "The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.",
"min": 0,
"max": "1",
"type": [{
"code": "Duration"
},
{
"code": "string"
}],
"isSummary": true
},
{
"id": "ProductShelfLife.specialPrecautionsForStorage",
"path": "ProductShelfLife.specialPrecautionsForStorage",
"short": "Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified",
"definition": "Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.",
"min": 0,
"max": "*",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Quantity",
"resource": {
"resourceType": "StructureDefinition",
"id": "Quantity",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Quantity ΣN Element A measured or measurable amount
+ Rule: If a code for the unit is present, the system SHALL also be present
Elements defined in Ancestors: id, extension value Σ 0..1 decimal Numerical value (with implicit precision)
comparator ?!Σ 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (Required)
unit ΣT 0..1 string Unit representation
system ΣC 0..1 uri System that defines coded unit form
code ΣC 0..1 code Coded form of the unit
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Quantity",
"version": "5.0.0",
"name": "Quantity",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Quantity Type: 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.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"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": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Quantity",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"base": {
"path": "Quantity",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,PQ, IVL, MO, CO, depending on the values"
},
{
"identity": "v2",
"map": "SN (see also Range) or CQ"
}]
},
{
"id": "Quantity.id",
"path": "Quantity.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Quantity.value",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "SN.2 / CQ - N/A"
},
{
"identity": "rim",
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
}]
},
{
"id": "Quantity.comparator",
"path": "Quantity.comparator",
"short": "< | <= | >= | > | ad - how to understand the value",
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.comparator",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How the Quantity should be understood and represented."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}]
},
{
"id": "Quantity.unit",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(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",
"base": {
"path": "Quantity.system",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "CO.codeSystem, PQ.translation.codeSystem"
}]
},
{
"id": "Quantity.code",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}],
"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": "< | <= | >= | > | ad - how to understand the value",
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How the Quantity should be understood and represented."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}]
},
{
"id": "Quantity.unit",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["qty-3"],
"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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Range ΣN Element Set of values bounded by low and high
+ Rule: If present, low SHALL have a lower value than high
Elements defined in Ancestors: id, extension low ΣC 0..1 SimpleQuantity Low limit
high ΣC 0..1 SimpleQuantity High limit
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Range",
"version": "5.0.0",
"name": "Range",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Range Type: A set of ordered Quantities defined by a low and high limit.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to be able to specify ranges of values.",
"fhirVersion": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Range",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "*",
"base": {
"path": "Range",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "rng-2",
"severity": "error",
"human": "If present, low SHALL have a lower value than high",
"expression": "low.value.empty() or high.value.empty() or low.lowBoundary().comparable(high.highBoundary()).not() or (low.lowBoundary() <= high.highBoundary())",
"source": "http://hl7.org/fhir/StructureDefinition/Range"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,IVL [lowClosed=\"true\" and highClosed=\"true\"]or URG"
},
{
"identity": "v2",
"map": "NR and also possibly SN (but see also quantity)"
}]
},
{
"id": "Range.id",
"path": "Range.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Range.low",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["rng-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "Range.high",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["rng-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "NR.2"
},
{
"identity": "rim",
"map": "./high"
}]
}]
},
"differential": {
"element": [{
"id": "Range",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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.value.empty() or high.value.empty() or low.lowBoundary().comparable(high.highBoundary()).not() or (low.lowBoundary() <= high.highBoundary())",
"source": "http://hl7.org/fhir/StructureDefinition/Range"
}],
"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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Ratio ΣN Element A ratio of two Quantity values - a numerator and a denominator
+ Rule: 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 ΣC 0..1 Quantity Numerator value
denominator ΣC 0..1 SimpleQuantity Denominator value
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Ratio",
"version": "5.0.0",
"name": "Ratio",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to able to capture ratios for some measurements (titers) and some rates (costs).",
"fhirVersion": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Ratio",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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.",
"comment": "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
"min": 0,
"max": "*",
"base": {
"path": "Ratio",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "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.exists() and denominator.exists()) or (numerator.empty() and denominator.empty() and extension.exists())",
"source": "http://hl7.org/fhir/StructureDefinition/Ratio"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,RTO"
},
{
"identity": "v2",
"map": "N/A"
}]
},
{
"id": "Ratio.id",
"path": "Ratio.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Ratio.numerator",
"path": "Ratio.numerator",
"short": "Numerator value",
"definition": "The value of the numerator.",
"min": 0,
"max": "1",
"base": {
"path": "Ratio.numerator",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity"
}],
"condition": ["rat-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": ".numerator"
}]
},
{
"id": "Ratio.denominator",
"path": "Ratio.denominator",
"short": "Denominator value",
"definition": "The value of the denominator.",
"min": 0,
"max": "1",
"base": {
"path": "Ratio.denominator",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["rat-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": ".denominator"
}]
}]
},
"differential": {
"element": [{
"id": "Ratio",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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.",
"comment": "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
"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.exists() and denominator.exists()) or (numerator.empty() and denominator.empty() and extension.exists())",
"source": "http://hl7.org/fhir/StructureDefinition/Ratio"
}],
"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"
}],
"condition": ["rat-1"],
"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",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["rat-1"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": ".denominator"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/RatioRange",
"resource": {
"resourceType": "StructureDefinition",
"id": "RatioRange",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints RatioRange ΣTU Element Range of ratio values
+ Rule: One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present
+ Rule: If present, lowNumerator SHALL have a lower value than highNumerator
Elements defined in Ancestors: id, extension lowNumerator ΣC 0..1 SimpleQuantity Low Numerator limit
highNumerator ΣC 0..1 SimpleQuantity High Numerator limit
denominator ΣC 0..1 SimpleQuantity Denominator value
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}],
"url": "http://hl7.org/fhir/StructureDefinition/RatioRange",
"version": "5.0.0",
"name": "RatioRange",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "RatioRange Type: A range of ratios expressed as a low and high numerator and a denominator.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "Need to be able to specify ranges of ratios.",
"fhirVersion": "5.0.0",
"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": "RatioRange",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "RatioRange",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "RatioRange",
"short": "Range of ratio values",
"definition": "A range of ratios expressed as a low and high numerator and a denominator.",
"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": "*",
"base": {
"path": "RatioRange",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ratrng-1",
"severity": "error",
"human": "One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present",
"expression": "((lowNumerator.exists() or highNumerator.exists()) and denominator.exists()) or (lowNumerator.empty() and highNumerator.empty() and denominator.empty() and extension.exists())",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange"
},
{
"key": "ratrng-2",
"severity": "error",
"human": "If present, lowNumerator SHALL have a lower value than highNumerator",
"expression": "lowNumerator.hasValue().not() or highNumerator.hasValue().not() or (lowNumerator.lowBoundary() <= highNumerator.highBoundary())",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,IVL> [lowClosed=\"true\" and highClosed=\"true\"]or URG<>"
},
{
"identity": "v2",
"map": "NR and also possibly SN (but see also quantity)"
}]
},
{
"id": "RatioRange.id",
"path": "RatioRange.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "RatioRange.extension",
"path": "RatioRange.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "RatioRange.lowNumerator",
"path": "RatioRange.lowNumerator",
"short": "Low Numerator limit",
"definition": "The value of the low limit numerator.",
"comment": "If the low element is missing, the low boundary is not known.",
"min": 0,
"max": "1",
"base": {
"path": "RatioRange.lowNumerator",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["ratrng-1",
"ratrng-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "NR.1"
},
{
"identity": "rim",
"map": "./low"
}]
},
{
"id": "RatioRange.highNumerator",
"path": "RatioRange.highNumerator",
"short": "High Numerator limit",
"definition": "The value of the high limit numerator.",
"comment": "If the high element is missing, the high boundary is not known.",
"min": 0,
"max": "1",
"base": {
"path": "RatioRange.highNumerator",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["ratrng-1",
"ratrng-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "NR.2"
},
{
"identity": "rim",
"map": "./high"
}]
},
{
"id": "RatioRange.denominator",
"path": "RatioRange.denominator",
"short": "Denominator value",
"definition": "The value of the denominator.",
"min": 0,
"max": "1",
"base": {
"path": "RatioRange.denominator",
"min": 0,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["ratrng-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "RatioRange",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "RatioRange",
"short": "Range of ratio values",
"definition": "A range of ratios expressed as a low and high numerator and a denominator.",
"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": "ratrng-1",
"severity": "error",
"human": "One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present",
"expression": "((lowNumerator.exists() or highNumerator.exists()) and denominator.exists()) or (lowNumerator.empty() and highNumerator.empty() and denominator.empty() and extension.exists())",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange"
},
{
"key": "ratrng-2",
"severity": "error",
"human": "If present, lowNumerator SHALL have a lower value than highNumerator",
"expression": "lowNumerator.hasValue().not() or highNumerator.hasValue().not() or (lowNumerator.lowBoundary() <= highNumerator.highBoundary())",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange"
}],
"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": "RatioRange.lowNumerator",
"path": "RatioRange.lowNumerator",
"short": "Low Numerator limit",
"definition": "The value of the low limit numerator.",
"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": ["ratrng-1",
"ratrng-2"],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "NR.1"
},
{
"identity": "rim",
"map": "./low"
}]
},
{
"id": "RatioRange.highNumerator",
"path": "RatioRange.highNumerator",
"short": "High Numerator limit",
"definition": "The value of the high limit numerator.",
"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": ["ratrng-1",
"ratrng-2"],
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "NR.2"
},
{
"identity": "rim",
"map": "./high"
}]
},
{
"id": "RatioRange.denominator",
"path": "RatioRange.denominator",
"short": "Denominator value",
"definition": "The value of the denominator.",
"min": 0,
"max": "1",
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition": ["ratrng-1"],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Reference",
"resource": {
"resourceType": "StructureDefinition",
"id": "Reference",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Reference ΣN Element A reference from one resource to another
+ Rule: SHALL have a contained resource if a local reference is provided
+ Rule: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
Elements defined in Ancestors: id, extension reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: Resource Types (Extensible)
identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
display ΣTC 0..1 string Text alternative for the resource
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-target"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Reference",
"version": "5.0.0",
"name": "Reference",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Reference Type: A reference from one resource to another.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Reference",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Reference",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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 resolvable (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": "*",
"base": {
"path": "Reference",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
},
{
"key": "ref-2",
"severity": "error",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
}]
},
{
"id": "Reference.id",
"path": "Reference.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["ref-2",
"ref-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "Reference.type",
"path": "Reference.type",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.type",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"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 target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [{
"code": "Identifier"
}],
"condition": ["ref-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": ".identifier"
}]
},
{
"id": "Reference.display",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["ref-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
},
"differential": {
"element": [{
"id": "Reference",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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 resolvable (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.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
},
{
"key": "ref-2",
"severity": "error",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}],
"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-2",
"ref-1"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "Reference.type",
"path": "Reference.type",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.",
"min": 0,
"max": "1",
"type": [{
"code": "uri"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"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 target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"min": 0,
"max": "1",
"type": [{
"code": "Identifier"
}],
"condition": ["ref-2"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": ".identifier"
}]
},
{
"id": "Reference.display",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"condition": ["ref-2"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/RelatedArtifact",
"resource": {
"resourceType": "StructureDefinition",
"id": "RelatedArtifact",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints RelatedArtifact ΣTU Element Related artifacts for a knowledge resource
Elements defined in Ancestors: id, extension type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (Required)
classifier Σ 0..* CodeableConcept Additional classifiers
Binding: Citation Artifact Classifier (Example)
label Σ 0..1 string Short label
display Σ 0..1 string Brief description of the related artifact
citation Σ 0..1 markdown Bibliographic citation for the artifact
document Σ 0..1 Attachment What document is being referenced
resource Σ 0..1 canonical(Any) What artifact is being referenced
resourceReference Σ 0..1 Reference(Any) What artifact, if not a conformance resource
publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
publicationDate Σ 0..1 date Date of publication of the artifact being referred to
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/RelatedArtifact",
"version": "5.0.0",
"name": "RelatedArtifact",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"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": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "RelatedArtifact",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "RelatedArtifact",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "RelatedArtifact",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "RelatedArtifact.id",
"path": "RelatedArtifact.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "RelatedArtifact.type",
"path": "RelatedArtifact.type",
"short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as",
"definition": "The type of relationship to the related artifact.",
"comment": "The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of \"new points to old\" and \"many points to one\", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.",
"min": 1,
"max": "1",
"base": {
"path": "RelatedArtifact.type",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The type of relationship to the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactType"
}],
"strength": "required",
"description": "The type of relationship to the related artifact.",
"valueSet": "http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0"
}
},
{
"id": "RelatedArtifact.classifier",
"path": "RelatedArtifact.classifier",
"short": "Additional classifiers",
"definition": "Provides additional classifiers of the related artifact.",
"min": 0,
"max": "*",
"base": {
"path": "RelatedArtifact.classifier",
"min": 0,
"max": "*"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Additional classifiers for the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactClassifier"
}],
"strength": "example",
"description": "Additional classifiers for the related artifact.",
"valueSet": "http://hl7.org/fhir/ValueSet/citation-artifact-classifier"
}
},
{
"id": "RelatedArtifact.label",
"path": "RelatedArtifact.label",
"short": "Short label",
"definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.label",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"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",
"base": {
"path": "RelatedArtifact.display",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "RelatedArtifact.citation",
"min": 0,
"max": "1"
},
"type": [{
"code": "markdown"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "RelatedArtifact.document",
"min": 0,
"max": "1"
},
"type": [{
"code": "Attachment"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.resource",
"path": "RelatedArtifact.resource",
"short": "What artifact is being referenced",
"definition": "The related artifact, 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",
"base": {
"path": "RelatedArtifact.resource",
"min": 0,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.resourceReference",
"path": "RelatedArtifact.resourceReference",
"short": "What artifact, if not a conformance resource",
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"comment": "If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.resourceReference",
"min": 0,
"max": "1"
},
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.publicationStatus",
"path": "RelatedArtifact.publicationStatus",
"short": "draft | active | retired | unknown",
"definition": "The publication status of the artifact being referred to.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.publicationStatus",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Publication status of an artifact being referred to."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactPublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "Publication status of an artifact being referred to.",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0"
}
},
{
"id": "RelatedArtifact.publicationDate",
"path": "RelatedArtifact.publicationDate",
"short": "Date of publication of the artifact being referred to",
"definition": "The date of publication of the artifact being referred to.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.publicationDate",
"min": 0,
"max": "1"
},
"type": [{
"code": "date"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "RelatedArtifact",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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 | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as",
"definition": "The type of relationship to the related artifact.",
"comment": "The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of \"new points to old\" and \"many points to one\", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.",
"min": 1,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The type of relationship to the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactType"
}],
"strength": "required",
"description": "The type of relationship to the related artifact.",
"valueSet": "http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0"
}
},
{
"id": "RelatedArtifact.classifier",
"path": "RelatedArtifact.classifier",
"short": "Additional classifiers",
"definition": "Provides additional classifiers of the related artifact.",
"min": 0,
"max": "*",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Additional classifiers for the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactClassifier"
}],
"strength": "example",
"description": "Additional classifiers for the related artifact.",
"valueSet": "http://hl7.org/fhir/ValueSet/citation-artifact-classifier"
}
},
{
"id": "RelatedArtifact.label",
"path": "RelatedArtifact.label",
"short": "Short label",
"definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
},
{
"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": "markdown"
}],
"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 artifact is being referenced",
"definition": "The related artifact, 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": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary": true
},
{
"id": "RelatedArtifact.resourceReference",
"path": "RelatedArtifact.resourceReference",
"short": "What artifact, if not a conformance resource",
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"comment": "If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.",
"min": 0,
"max": "1",
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary": true
},
{
"id": "RelatedArtifact.publicationStatus",
"path": "RelatedArtifact.publicationStatus",
"short": "draft | active | retired | unknown",
"definition": "The publication status of the artifact being referred to.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Publication status of an artifact being referred to."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactPublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "Publication status of an artifact being referred to.",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0"
}
},
{
"id": "RelatedArtifact.publicationDate",
"path": "RelatedArtifact.publicationDate",
"short": "Date of publication of the artifact being referred to",
"definition": "The date of publication of the artifact being referred to.",
"min": 0,
"max": "1",
"type": [{
"code": "date"
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/SampledData",
"resource": {
"resourceType": "StructureDefinition",
"id": "SampledData",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints SampledData TU Element A series of measurements taken by a device
+ Rule: A SampledData SAHLL have either an interval and offsets but not both
Elements defined in Ancestors: id, extension origin Σ 1..1 SimpleQuantity Zero value and units
interval ΣC 0..1 decimal Number of intervalUnits between samples
intervalUnit Σ 1..1 code The measurement unit of the interval between samples
Binding: UCUM Codes (Required)
factor Σ 0..1 decimal Multiply data by this before adding to origin
lowerLimit Σ 0..1 decimal Lower limit of detection
upperLimit Σ 0..1 decimal Upper limit of detection
dimensions Σ 1..1 positiveInt Number of sample points at each time point
codeMap 0..1 canonical(ConceptMap) Defines the codes used in the data
offsets C 0..1 string Offsets, typically in time, at which data values were taken
data 0..1 string Decimal values with spaces, or "E" | "U" | "L", or another code
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/SampledData",
"version": "5.0.0",
"name": "SampledData",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"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": "5.0.0",
"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/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "SampledData",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "SampledData",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "sdd-1",
"severity": "error",
"human": "A SampledData SAHLL have either an interval and offsets but not both",
"expression": "interval.exists().not() xor offsets.exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/SampledData"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,SLIST + GLIST"
},
{
"identity": "v2",
"map": "N/A (but see section 7.14 in v2.7)"
}]
},
{
"id": "SampledData.id",
"path": "SampledData.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "SampledData.origin",
"min": 1,
"max": "1"
},
"type": [{
"code": "Quantity",
"profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "SLIST.origin"
}]
},
{
"id": "SampledData.interval",
"path": "SampledData.interval",
"short": "Number of intervalUnits between samples",
"definition": "Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.",
"comment": "This is usually a whole number.",
"min": 0,
"max": "1",
"base": {
"path": "SampledData.interval",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"condition": ["sdd-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "GLIST.increment"
}]
},
{
"id": "SampledData.intervalUnit",
"path": "SampledData.intervalUnit",
"short": "The measurement unit of the interval between samples",
"definition": "The measurement unit in which the sample interval is expressed.",
"min": 1,
"max": "1",
"base": {
"path": "SampledData.intervalUnit",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Units of measure allowed for an element."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Units"
}],
"strength": "required",
"description": "Units of measure allowed for an element.",
"valueSet": "http://hl7.org/fhir/ValueSet/ucum-units|5.0.0"
}
},
{
"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",
"base": {
"path": "SampledData.factor",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"meaningWhenMissing": "If no factor is assigned, the data is not adjusted before adding to the origin",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "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",
"base": {
"path": "SampledData.lowerLimit",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "SampledData.upperLimit",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "SampledData.dimensions",
"min": 1,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A (fixed to 1)"
}]
},
{
"id": "SampledData.codeMap",
"path": "SampledData.codeMap",
"short": "Defines the codes used in the data",
"definition": "Reference to ConceptMap that defines the codes used in the data.",
"comment": "The ConceptMap cannot define meanings for the codes 'E', 'U', or 'L' (nor 'e', 'u', or 'l').",
"min": 0,
"max": "1",
"base": {
"path": "SampledData.codeMap",
"min": 0,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ConceptMap"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "SampledData.offsets",
"path": "SampledData.offsets",
"short": "Offsets, typically in time, at which data values were taken",
"definition": "A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.",
"comment": "If offsets is present, the number of data points must be equal to the number of offsets mlutipled by the dimensions.",
"min": 0,
"max": "1",
"base": {
"path": "SampledData.offsets",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["sdd-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "SampledData.data",
"path": "SampledData.data",
"short": "Decimal values with spaces, or \"E\" | \"U\" | \"L\", or another code",
"definition": "A series of data points which are decimal values or codes separated by a single space (character u20). The special codes \"E\" (error), \"L\" (below detection limit) and \"U\" (above detection limit) are also defined for used in place of decimal values.",
"comment": "The data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData.",
"min": 0,
"max": "1",
"base": {
"path": "SampledData.data",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "SLIST.digits"
}]
}]
},
"differential": {
"element": [{
"id": "SampledData",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"constraint": [{
"key": "sdd-1",
"severity": "error",
"human": "A SampledData SAHLL have either an interval and offsets but not both",
"expression": "interval.exists().not() xor offsets.exists().not()",
"source": "http://hl7.org/fhir/StructureDefinition/SampledData"
}],
"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.interval",
"path": "SampledData.interval",
"short": "Number of intervalUnits between samples",
"definition": "Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.",
"comment": "This is usually a whole number.",
"min": 0,
"max": "1",
"type": [{
"code": "decimal"
}],
"condition": ["sdd-1"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "GLIST.increment"
}]
},
{
"id": "SampledData.intervalUnit",
"path": "SampledData.intervalUnit",
"short": "The measurement unit of the interval between samples",
"definition": "The measurement unit in which the sample interval is expressed.",
"min": 1,
"max": "1",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Units of measure allowed for an element."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Units"
}],
"strength": "required",
"description": "Units of measure allowed for an element.",
"valueSet": "http://hl7.org/fhir/ValueSet/ucum-units|5.0.0"
}
},
{
"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"
}],
"meaningWhenMissing": "If no factor is assigned, the data is not adjusted before adding to the origin",
"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.codeMap",
"path": "SampledData.codeMap",
"short": "Defines the codes used in the data",
"definition": "Reference to ConceptMap that defines the codes used in the data.",
"comment": "The ConceptMap cannot define meanings for the codes 'E', 'U', or 'L' (nor 'e', 'u', or 'l').",
"min": 0,
"max": "1",
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/ConceptMap"]
}],
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "SampledData.offsets",
"path": "SampledData.offsets",
"short": "Offsets, typically in time, at which data values were taken",
"definition": "A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.",
"comment": "If offsets is present, the number of data points must be equal to the number of offsets mlutipled by the dimensions.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["sdd-1"],
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "SampledData.data",
"path": "SampledData.data",
"short": "Decimal values with spaces, or \"E\" | \"U\" | \"L\", or another code",
"definition": "A series of data points which are decimal values or codes separated by a single space (character u20). The special codes \"E\" (error), \"L\" (below detection limit) and \"U\" (above detection limit) are also defined for used in place of decimal values.",
"comment": "The data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData.",
"min": 0,
"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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Signature TU Element A Signature - XML DigSig, JWS, Graphical image of signature, etc.
Elements defined in Ancestors: id, extension type Σ 0..* Coding Indication of the reason the entity signed the object(s)
Binding: Signature Type Codes (Preferred)
when Σ 0..1 instant When the signature was created
who Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (Required)
sigFormat 0..1 code The technical format of the signature
Binding: Mime Types (Required)
data 0..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Signature",
"version": "5.0.0",
"name": "Signature",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"purpose": "There are a number of places where content must be signed in healthcare.",
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "Signature",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Signature",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Signature",
"short": "A Signature - XML DigSig, JWS, Graphical image of signature, etc.",
"definition": "A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.",
"comment": "The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.",
"min": 0,
"max": "*",
"base": {
"path": "Signature",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,N/A"
}]
},
{
"id": "Signature.id",
"path": "Signature.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Signature.extension",
"path": "Signature.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Signature.type",
"path": "Signature.type",
"short": "Indication of the reason the entity signed the object(s)",
"definition": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.",
"comment": "Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".",
"min": 0,
"max": "*",
"base": {
"path": "Signature.type",
"min": 0,
"max": "*"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "An indication of the reason that an entity signed the object."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SignatureType"
}],
"strength": "preferred",
"description": "An indication of the reason that an entity signed the object.",
"valueSet": "http://hl7.org/fhir/ValueSet/signature-type"
}
},
{
"id": "Signature.when",
"path": "Signature.when",
"short": "When the signature was created",
"definition": "When the digital signature was signed.",
"comment": "This should agree with the information in the signature.",
"min": 0,
"max": "1",
"base": {
"path": "Signature.when",
"min": 0,
"max": "1"
},
"type": [{
"code": "instant"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Signature.who",
"path": "Signature.who",
"short": "Who signed",
"definition": "A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).",
"comment": "This should agree with the information in the signature.",
"min": 0,
"max": "1",
"base": {
"path": "Signature.who",
"min": 0,
"max": "1"
},
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Signature.onBehalfOf",
"path": "Signature.onBehalfOf",
"short": "The party represented",
"definition": "A reference to an application-usable description of the identity that is represented by the signature.",
"comment": "The party that can't sign. For example a child.",
"requirements": "used when the signature is on behalf of a non-signer.",
"min": 0,
"max": "1",
"base": {
"path": "Signature.onBehalfOf",
"min": 0,
"max": "1"
},
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "Signature.targetFormat",
"path": "Signature.targetFormat",
"short": "The technical format of the signed resources",
"definition": "A mime type that indicates the technical format of the target resources signed by the signature.",
"comment": "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min": 0,
"max": "1",
"base": {
"path": "Signature.targetFormat",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"
}
},
{
"id": "Signature.sigFormat",
"path": "Signature.sigFormat",
"short": "The technical format of the signature",
"definition": "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Signature.sigFormat",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"
}
},
{
"id": "Signature.data",
"path": "Signature.data",
"short": "The actual signature content (XML DigSig. JWS, picture, etc.)",
"definition": "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.",
"comment": "Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) \"Detached Signature\" form.",
"min": 0,
"max": "1",
"base": {
"path": "Signature.data",
"min": 0,
"max": "1"
},
"type": [{
"code": "base64Binary"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": false
}]
},
"differential": {
"element": [{
"id": "Signature",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "Signature",
"short": "A Signature - XML DigSig, JWS, Graphical image of signature, etc.",
"definition": "A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.",
"comment": "The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.",
"min": 0,
"max": "*",
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "Signature.type",
"path": "Signature.type",
"short": "Indication of the reason the entity signed the object(s)",
"definition": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.",
"comment": "Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".",
"min": 0,
"max": "*",
"type": [{
"code": "Coding"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "An indication of the reason that an entity signed the object."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SignatureType"
}],
"strength": "preferred",
"description": "An indication of the reason that an entity signed the object.",
"valueSet": "http://hl7.org/fhir/ValueSet/signature-type"
}
},
{
"id": "Signature.when",
"path": "Signature.when",
"short": "When the signature was created",
"definition": "When the digital signature was signed.",
"comment": "This should agree with the information in the signature.",
"min": 0,
"max": "1",
"type": [{
"code": "instant"
}],
"isSummary": true
},
{
"id": "Signature.who",
"path": "Signature.who",
"short": "Who signed",
"definition": "A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).",
"comment": "This should agree with the information in the signature.",
"min": 0,
"max": "1",
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary": true
},
{
"id": "Signature.onBehalfOf",
"path": "Signature.onBehalfOf",
"short": "The party represented",
"definition": "A reference to an application-usable description of the identity that is represented by the signature.",
"comment": "The party that can't sign. For example a child.",
"requirements": "used when the signature is on behalf of a non-signer.",
"min": 0,
"max": "1",
"type": [{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary": true
},
{
"id": "Signature.targetFormat",
"path": "Signature.targetFormat",
"short": "The technical format of the signed resources",
"definition": "A mime type that indicates the technical format of the target resources signed by the signature.",
"comment": "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"
}
},
{
"id": "Signature.sigFormat",
"path": "Signature.sigFormat",
"short": "The technical format of the signature",
"definition": "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "required",
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"
}
},
{
"id": "Signature.data",
"path": "Signature.data",
"short": "The actual signature content (XML DigSig. JWS, picture, etc.)",
"definition": "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.",
"comment": "Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) \"Detached Signature\" form.",
"min": 0,
"max": "1",
"type": [{
"code": "base64Binary"
}]
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/Timing",
"resource": {
"resourceType": "StructureDefinition",
"id": "Timing",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints Timing ΣN Element A timing schedule that specifies an event that may occur multiple times
Elements defined in Ancestors: id, extension, modifierExtension event Σ 0..* dateTime When the event occurs
repeat ΣC 0..1 Element When the event is to occur
+ Rule: if there's a duration, there needs to be duration units
+ Rule: if there's a period, there needs to be period units
+ Rule: duration SHALL be a non-negative value
+ Rule: period SHALL be a non-negative value
+ Rule: If there's a periodMax, there must be a period
+ Rule: If there's a durationMax, there must be a duration
+ Rule: If there's a countMax, there must be a count
+ Rule: If there's an offset, there must be a when (and not C, CM, CD, CV)
+ Rule: If there's a timeOfDay, there cannot be a when, or vice versa
bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
boundsDuration Duration boundsRange Range boundsPeriod Period count ΣC 0..1 positiveInt Number of times to repeat
countMax ΣC 0..1 positiveInt Maximum number of times to repeat
duration ΣC 0..1 decimal How long when it happens
durationMax ΣC 0..1 decimal How long when it happens (Max)
durationUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (Required)
frequency Σ 0..1 positiveInt Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period
frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
period ΣC 0..1 decimal The duration to which the frequency applies. I.e. Event occurs frequency times per period
periodMax ΣC 0..1 decimal Upper limit of period (3-4 hours)
periodUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (Required)
dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: Days Of Week (Required)
timeOfDay ΣC 0..* time Time of day for action
when ΣC 0..* code Code for time period of occurrence
Binding: EventTiming (Required)
offset ΣC 0..1 unsignedInt Minutes from event (before or after)
code Σ 0..1 CodeableConcept C | BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (Preferred)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"url": "http://hl7.org/fhir/StructureDefinition/Timing",
"version": "5.0.0",
"name": "Timing",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "Timing Type: 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.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"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": "5.0.0",
"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/BackboneType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "Timing",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events.\n\nA Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. 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": "*",
"base": {
"path": "Timing",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,QSET (GTS)"
},
{
"identity": "v2",
"map": "N/A"
}]
},
{
"id": "Timing.id",
"path": "Timing.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Timing.modifierExtension",
"path": "Timing.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": ["extensions",
"user content",
"modifiers"],
"min": 0,
"max": "*",
"base": {
"path": "BackboneType.modifierExtension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "N/A"
}]
},
{
"id": "Timing.event",
"path": "Timing.event",
"short": "When the event occurs",
"definition": "Identifies specific times when the event occurs.",
"requirements": "In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.",
"min": 0,
"max": "*",
"base": {
"path": "Timing.event",
"min": 0,
"max": "*"
},
"type": [{
"code": "dateTime"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "Timing.repeat",
"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() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "tim-1",
"severity": "error",
"human": "if there's a duration, there needs to be duration units",
"expression": "duration.empty() or durationUnit.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-2",
"severity": "error",
"human": "if there's a period, there needs to be period units",
"expression": "period.empty() or periodUnit.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-4",
"severity": "error",
"human": "duration SHALL be a non-negative value",
"expression": "duration.exists() implies duration >= 0",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-5",
"severity": "error",
"human": "period SHALL be a non-negative value",
"expression": "period.exists() implies period >= 0",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-6",
"severity": "error",
"human": "If there's a periodMax, there must be a period",
"expression": "periodMax.empty() or period.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-7",
"severity": "error",
"human": "If there's a durationMax, there must be a duration",
"expression": "durationMax.empty() or duration.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-8",
"severity": "error",
"human": "If there's a countMax, there must be a count",
"expression": "countMax.empty() or count.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"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.select($this in ('C' | 'CM' | 'CD' | 'CV')).allFalse())",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-10",
"severity": "error",
"human": "If there's a timeOfDay, there cannot be a when, or vice versa",
"expression": "timeOfDay.empty() or when.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "Implies PIVL or EIVL"
}]
},
{
"id": "Timing.repeat.id",
"path": "Timing.repeat.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Timing.repeat.bounds[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "Duration"
},
{
"code": "Range"
},
{
"code": "Period"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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 across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.",
"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",
"base": {
"path": "Timing.repeat.count",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"condition": ["tim-8"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "PIVL.count"
}]
},
{
"id": "Timing.repeat.countMax",
"path": "Timing.repeat.countMax",
"short": "Maximum number of times to repeat",
"definition": "If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.",
"min": 0,
"max": "1",
"base": {
"path": "Timing.repeat.countMax",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"condition": ["tim-8"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.",
"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",
"base": {
"path": "Timing.repeat.duration",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"condition": ["tim-7",
"tim-1",
"tim-4"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "PIVL.phase"
}]
},
{
"id": "Timing.repeat.durationMax",
"path": "Timing.repeat.durationMax",
"short": "How long when it happens (Max)",
"definition": "If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.",
"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",
"base": {
"path": "Timing.repeat.durationMax",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"condition": ["tim-7"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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\nNormal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.",
"min": 0,
"max": "1",
"base": {
"path": "Timing.repeat.durationUnit",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["tim-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A unit of time (units from UCUM)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UnitsOfTime"
}],
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSet": "http://hl7.org/fhir/ValueSet/units-of-time|5.0.0"
},
"mapping": [{
"identity": "rim",
"map": "PIVL.phase.unit"
}]
},
{
"id": "Timing.repeat.frequency",
"path": "Timing.repeat.frequency",
"short": "Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period",
"definition": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.",
"min": 0,
"max": "1",
"base": {
"path": "Timing.repeat.frequency",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"meaningWhenMissing": "If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "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",
"base": {
"path": "Timing.repeat.frequencyMax",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "PIVL.phase"
}]
},
{
"id": "Timing.repeat.period",
"path": "Timing.repeat.period",
"short": "The duration to which the frequency applies. I.e. 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. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.",
"min": 0,
"max": "1",
"base": {
"path": "Timing.repeat.period",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"condition": ["tim-6",
"tim-5",
"tim-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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",
"base": {
"path": "Timing.repeat.periodMax",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"condition": ["tim-6"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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\nNormal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.",
"min": 0,
"max": "1",
"base": {
"path": "Timing.repeat.periodUnit",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["tim-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A unit of time (units from UCUM)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UnitsOfTime"
}],
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSet": "http://hl7.org/fhir/ValueSet/units-of-time|5.0.0"
},
"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.",
"min": 0,
"max": "*",
"base": {
"path": "Timing.repeat.dayOfWeek",
"min": 0,
"max": "*"
},
"type": [{
"code": "code"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DayOfWeek"
}],
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|5.0.0"
},
"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. If there's a timeOfDay, there cannot be a when, or vice versa.",
"min": 0,
"max": "*",
"base": {
"path": "Timing.repeat.timeOfDay",
"min": 0,
"max": "*"
},
"type": [{
"code": "time"
}],
"condition": ["tim-10"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Timing.repeat.when",
"path": "Timing.repeat.when",
"short": "Code for time period of occurrence",
"definition": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.",
"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": "*",
"base": {
"path": "Timing.repeat.when",
"min": 0,
"max": "*"
},
"type": [{
"code": "code"
}],
"condition": ["tim-9",
"tim-10"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Real-world event relating to the schedule."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventTiming"
}],
"strength": "required",
"description": "Real-world event relating to the schedule.",
"valueSet": "http://hl7.org/fhir/ValueSet/event-timing|5.0.0"
},
"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",
"base": {
"path": "Timing.repeat.offset",
"min": 0,
"max": "1"
},
"type": [{
"code": "unsignedInt"
}],
"condition": ["tim-9"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "EIVL.offset"
}]
},
{
"id": "Timing.code",
"path": "Timing.code",
"short": "C | BID | TID | QID | AM | PM | QD | QOD | +",
"definition": "A code for the timing schedule (or just text in code.text). 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 a structured representation should be used (in this case, specifying the two event times).",
"min": 0,
"max": "1",
"base": {
"path": "Timing.code",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Code for a known / defined timing pattern."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TimingAbbreviation"
}],
"strength": "preferred",
"description": "Code for a known / defined timing pattern.",
"valueSet": "http://hl7.org/fhir/ValueSet/timing-abbreviation"
},
"mapping": [{
"identity": "rim",
"map": "QSC.code"
}]
}]
},
"differential": {
"element": [{
"id": "Timing",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}],
"path": "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": "Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events.\n\nA Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. 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 a Medication Administration Record, 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.select($this in ('C' | 'CM' | 'CD' | 'CV')).allFalse())",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-5",
"severity": "error",
"human": "period SHALL be a non-negative value",
"expression": "period.exists() implies period >= 0",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-6",
"severity": "error",
"human": "If there's a periodMax, there must be a period",
"expression": "periodMax.empty() or period.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-7",
"severity": "error",
"human": "If there's a durationMax, there must be a duration",
"expression": "durationMax.empty() or duration.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-8",
"severity": "error",
"human": "If there's a countMax, there must be a count",
"expression": "countMax.empty() or count.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-1",
"severity": "error",
"human": "if there's a duration, there needs to be duration units",
"expression": "duration.empty() or durationUnit.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-10",
"severity": "error",
"human": "If there's a timeOfDay, there cannot be a when, or vice versa",
"expression": "timeOfDay.empty() or when.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-2",
"severity": "error",
"human": "if there's a period, there needs to be period units",
"expression": "period.empty() or periodUnit.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
},
{
"key": "tim-4",
"severity": "error",
"human": "duration SHALL be a non-negative value",
"expression": "duration.exists() implies duration >= 0",
"source": "http://hl7.org/fhir/StructureDefinition/Timing"
}],
"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 across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.",
"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": "positiveInt"
}],
"condition": ["tim-8"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "PIVL.count"
}]
},
{
"id": "Timing.repeat.countMax",
"path": "Timing.repeat.countMax",
"short": "Maximum number of times to repeat",
"definition": "If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}],
"condition": ["tim-8"],
"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. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.",
"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"
}],
"condition": ["tim-7",
"tim-1",
"tim-4"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "PIVL.phase"
}]
},
{
"id": "Timing.repeat.durationMax",
"path": "Timing.repeat.durationMax",
"short": "How long when it happens (Max)",
"definition": "If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.",
"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"
}],
"condition": ["tim-7"],
"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\nNormal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"condition": ["tim-1"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A unit of time (units from UCUM)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UnitsOfTime"
}],
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSet": "http://hl7.org/fhir/ValueSet/units-of-time|5.0.0"
},
"mapping": [{
"identity": "rim",
"map": "PIVL.phase.unit"
}]
},
{
"id": "Timing.repeat.frequency",
"path": "Timing.repeat.frequency",
"short": "Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period",
"definition": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}],
"meaningWhenMissing": "If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this",
"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": "positiveInt"
}],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "PIVL.phase"
}]
},
{
"id": "Timing.repeat.period",
"path": "Timing.repeat.period",
"short": "The duration to which the frequency applies. I.e. 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. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.",
"min": 0,
"max": "1",
"type": [{
"code": "decimal"
}],
"condition": ["tim-6",
"tim-5",
"tim-2"],
"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"
}],
"condition": ["tim-6"],
"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\nNormal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.",
"min": 0,
"max": "1",
"type": [{
"code": "code"
}],
"condition": ["tim-2"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A unit of time (units from UCUM)."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UnitsOfTime"
}],
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSet": "http://hl7.org/fhir/ValueSet/units-of-time|5.0.0"
},
"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.",
"min": 0,
"max": "*",
"type": [{
"code": "code"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DayOfWeek"
}],
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|5.0.0"
},
"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. If there's a timeOfDay, there cannot be a when, or vice versa.",
"min": 0,
"max": "*",
"type": [{
"code": "time"
}],
"condition": ["tim-10"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "Timing.repeat.when",
"path": "Timing.repeat.when",
"short": "Code for time period of occurrence",
"definition": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.",
"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"
}],
"condition": ["tim-9",
"tim-10"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Real-world event relating to the schedule."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventTiming"
}],
"strength": "required",
"description": "Real-world event relating to the schedule.",
"valueSet": "http://hl7.org/fhir/ValueSet/event-timing|5.0.0"
},
"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"
}],
"condition": ["tim-9"],
"isSummary": true,
"mapping": [{
"identity": "rim",
"map": "EIVL.offset"
}]
},
{
"id": "Timing.code",
"path": "Timing.code",
"short": "C | BID | TID | QID | AM | PM | QD | QOD | +",
"definition": "A code for the timing schedule (or just text in code.text). 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 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/tools/StructureDefinition/binding-definition",
"valueString": "Code for a known / defined timing pattern."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TimingAbbreviation"
}],
"strength": "preferred",
"description": "Code for a known / defined timing pattern.",
"valueSet": "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": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints TriggerDefinition ΣTU Element Defines an expected trigger for a module
+ Rule: Either timing, or a data requirement, but not both
+ Rule: A condition only if there is a data requirement
+ Rule: A named event requires a name, a periodic event requires timing, and a data event requires data
Elements defined in Ancestors: id, extension type ΣC 1..1 code named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Binding: TriggerType (Required)
name ΣC 0..1 string Name or URI that identifies the event
code Σ 0..1 CodeableConcept Coded definition of the event
subscriptionTopic Σ 0..1 canonical(SubscriptionTopic) What event
timing[x] ΣC 0..1 Timing of the event
timingTiming Timing timingReference Reference(Schedule) timingDate date timingDateTime dateTime data ΣC 0..* DataRequirement Triggering data of the event (multiple = 'and')
condition ΣC 0..1 Expression Whether the event triggers (boolean expression)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition",
"version": "5.0.0",
"name": "TriggerDefinition",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "TriggerDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "TriggerDefinition",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "TriggerDefinition",
"short": "Defines an expected trigger for a module",
"definition": "A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.",
"comment": "If an event is a named-event, it means the event is completely pre-coordinated, and no other information can be specified for the event. If the event is one of the data- events, the data and condition elements specify the triggering criteria. The data element specifies the structured component, and the condition element provides additional optional refinement of that structured component. If the event is periodic, the timing element defines when the event is triggered. For both data- and periodic events, a name can be provided as a shorthand for the formal semantics provided by the other elements.",
"min": 0,
"max": "*",
"base": {
"path": "TriggerDefinition",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "trd-1",
"severity": "error",
"human": "Either timing, or a data requirement, but not both",
"expression": "data.empty() or timing.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition"
},
{
"key": "trd-2",
"severity": "error",
"human": "A condition only if there is a data requirement",
"expression": "condition.exists() implies data.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition"
},
{
"key": "trd-3",
"severity": "error",
"human": "A named event requires a name, a periodic event requires timing, and a data event requires data",
"expression": "(type = 'named-event' implies name.exists()) and (type = 'periodic' implies timing.exists()) and (type.startsWith('data-') implies data.exists())",
"source": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "TriggerDefinition.id",
"path": "TriggerDefinition.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "TriggerDefinition.type",
"path": "TriggerDefinition.type",
"short": "named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended",
"definition": "The type of triggering event.",
"min": 1,
"max": "1",
"base": {
"path": "TriggerDefinition.type",
"min": 1,
"max": "1"
},
"type": [{
"code": "code"
}],
"condition": ["trd-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The type of trigger."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TriggerType"
}],
"strength": "required",
"description": "The type of trigger.",
"valueSet": "http://hl7.org/fhir/ValueSet/trigger-type|5.0.0"
}
},
{
"id": "TriggerDefinition.name",
"path": "TriggerDefinition.name",
"short": "Name or URI that identifies the event",
"definition": "A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.",
"comment": "An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.",
"min": 0,
"max": "1",
"base": {
"path": "TriggerDefinition.name",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"condition": ["trd-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "TriggerDefinition.code",
"path": "TriggerDefinition.code",
"short": "Coded definition of the event",
"definition": "A code that identifies the event.",
"min": 0,
"max": "1",
"base": {
"path": "TriggerDefinition.code",
"min": 0,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "TriggerDefinition.subscriptionTopic",
"path": "TriggerDefinition.subscriptionTopic",
"short": "What event",
"definition": "A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.",
"min": 0,
"max": "1",
"base": {
"path": "TriggerDefinition.subscriptionTopic",
"min": 0,
"max": "1"
},
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "TriggerDefinition.timing[x]",
"path": "TriggerDefinition.timing[x]",
"short": "Timing of the event",
"definition": "The timing of the event (if this is a periodic trigger).",
"min": 0,
"max": "1",
"base": {
"path": "TriggerDefinition.timing[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "Timing"
},
{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Schedule"]
},
{
"code": "date"
},
{
"code": "dateTime"
}],
"condition": ["trd-3",
"trd-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "TriggerDefinition.data",
"path": "TriggerDefinition.data",
"short": "Triggering data of the event (multiple = 'and')",
"definition": "The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.",
"comment": "This element shall be present for any data type trigger.",
"min": 0,
"max": "*",
"base": {
"path": "TriggerDefinition.data",
"min": 0,
"max": "*"
},
"type": [{
"code": "DataRequirement"
}],
"condition": ["trd-3",
"trd-2",
"trd-1"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "TriggerDefinition.condition",
"path": "TriggerDefinition.condition",
"short": "Whether the event triggers (boolean expression)",
"definition": "A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.",
"comment": "This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.",
"requirements": "Need to be able to formally describe the triggering criteria.",
"min": 0,
"max": "1",
"base": {
"path": "TriggerDefinition.condition",
"min": 0,
"max": "1"
},
"type": [{
"code": "Expression"
}],
"condition": ["trd-2"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "TriggerDefinition",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "TriggerDefinition",
"short": "Defines an expected trigger for a module",
"definition": "A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.",
"comment": "If an event is a named-event, it means the event is completely pre-coordinated, and no other information can be specified for the event. If the event is one of the data- events, the data and condition elements specify the triggering criteria. The data element specifies the structured component, and the condition element provides additional optional refinement of that structured component. If the event is periodic, the timing element defines when the event is triggered. For both data- and periodic events, a name can be provided as a shorthand for the formal semantics provided by the other elements.",
"min": 0,
"max": "*",
"constraint": [{
"key": "trd-3",
"severity": "error",
"human": "A named event requires a name, a periodic event requires timing, and a data event requires data",
"expression": "(type = 'named-event' implies name.exists()) and (type = 'periodic' implies timing.exists()) and (type.startsWith('data-') implies data.exists())",
"source": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition"
},
{
"key": "trd-2",
"severity": "error",
"human": "A condition only if there is a data requirement",
"expression": "condition.exists() implies data.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition"
},
{
"key": "trd-1",
"severity": "error",
"human": "Either timing, or a data requirement, but not both",
"expression": "data.empty() or timing.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/TriggerDefinition"
}]
},
{
"id": "TriggerDefinition.type",
"path": "TriggerDefinition.type",
"short": "named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended",
"definition": "The type of triggering event.",
"min": 1,
"max": "1",
"type": [{
"code": "code"
}],
"condition": ["trd-3"],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The type of trigger."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TriggerType"
}],
"strength": "required",
"description": "The type of trigger.",
"valueSet": "http://hl7.org/fhir/ValueSet/trigger-type|5.0.0"
}
},
{
"id": "TriggerDefinition.name",
"path": "TriggerDefinition.name",
"short": "Name or URI that identifies the event",
"definition": "A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.",
"comment": "An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"condition": ["trd-3"],
"isSummary": true
},
{
"id": "TriggerDefinition.code",
"path": "TriggerDefinition.code",
"short": "Coded definition of the event",
"definition": "A code that identifies the event.",
"min": 0,
"max": "1",
"type": [{
"code": "CodeableConcept"
}],
"isSummary": true
},
{
"id": "TriggerDefinition.subscriptionTopic",
"path": "TriggerDefinition.subscriptionTopic",
"short": "What event",
"definition": "A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.",
"min": 0,
"max": "1",
"type": [{
"code": "canonical",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]
}],
"isSummary": true
},
{
"id": "TriggerDefinition.timing[x]",
"path": "TriggerDefinition.timing[x]",
"short": "Timing of the event",
"definition": "The timing of the event (if this is a periodic trigger).",
"min": 0,
"max": "1",
"type": [{
"code": "Timing"
},
{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/Schedule"]
},
{
"code": "date"
},
{
"code": "dateTime"
}],
"condition": ["trd-3",
"trd-1"],
"isSummary": true
},
{
"id": "TriggerDefinition.data",
"path": "TriggerDefinition.data",
"short": "Triggering data of the event (multiple = 'and')",
"definition": "The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.",
"comment": "This element shall be present for any data type trigger.",
"min": 0,
"max": "*",
"type": [{
"code": "DataRequirement"
}],
"condition": ["trd-3",
"trd-2",
"trd-1"],
"isSummary": true
},
{
"id": "TriggerDefinition.condition",
"path": "TriggerDefinition.condition",
"short": "Whether the event triggers (boolean expression)",
"definition": "A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.",
"comment": "This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.",
"requirements": "Need to be able to formally describe the triggering criteria.",
"min": 0,
"max": "1",
"type": [{
"code": "Expression"
}],
"condition": ["trd-2"],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/UsageContext",
"resource": {
"resourceType": "StructureDefinition",
"id": "UsageContext",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints UsageContext ΣTU Element Describes the context of use for a conformance or knowledge resource
Elements defined in Ancestors: id, extension code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (Extensible)
value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (Example)
valueCodeableConcept CodeableConcept valueQuantity Quantity valueRange Range valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/UsageContext",
"version": "5.0.0",
"name": "UsageContext",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "UsageContext Type: 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).",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"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": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "UsageContext",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "UsageContext",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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": "*",
"base": {
"path": "UsageContext",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "UsageContext.id",
"path": "UsageContext.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "UsageContext.code",
"min": 1,
"max": "1"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A code that specifies a type of context being specified by a usage context."
},
{
"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.",
"valueSet": "http://terminology.hl7.org/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",
"base": {
"path": "UsageContext.value[x]",
"min": 1,
"max": "1"
},
"type": [{
"code": "CodeableConcept"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ResearchStudy",
"http://hl7.org/fhir/StructureDefinition/InsurancePlan",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A code that defines the specific value for the context being specified."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UsageContextValue"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "example",
"description": "A code that defines the specific value for the context being specified.",
"valueSet": "http://hl7.org/fhir/ValueSet/use-context"
}
}]
},
"differential": {
"element": [{
"id": "UsageContext",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"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/tools/StructureDefinition/binding-definition",
"valueString": "A code that specifies a type of context being specified by a usage context."
},
{
"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.",
"valueSet": "http://terminology.hl7.org/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"
},
{
"code": "Reference",
"targetProfile": ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ResearchStudy",
"http://hl7.org/fhir/StructureDefinition/InsurancePlan",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "A code that defines the specific value for the context being specified."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UsageContextValue"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}],
"strength": "example",
"description": "A code that defines the specific value for the context being specified.",
"valueSet": "http://hl7.org/fhir/ValueSet/use-context"
}
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/VirtualServiceDetail",
"resource": {
"resourceType": "StructureDefinition",
"id": "VirtualServiceDetail",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Name Flags Card. Type Description & Constraints VirtualServiceDetail ΣTU Element Virtual Service Contact Details
Elements defined in Ancestors: id, extension channelType Σ 0..1 Coding Channel Type
Binding: Virtual Service Type (Example)
address[x] Σ 0..1 Contact address/number
addressUrl url addressString string addressContactPoint ContactPoint addressExtendedContactDetail ExtendedContactDetail additionalInfo Σ 0..* url Address to see alternative connection details
maxParticipants Σ 0..1 positiveInt Maximum number of participants supported by the virtual service
sessionKey Σ 0..1 string Session Key required by the virtual service
Documentation for this format
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"url": "http://hl7.org/fhir/StructureDefinition/VirtualServiceDetail",
"version": "5.0.0",
"name": "VirtualServiceDetail",
"status": "draft",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "VirtualServiceDetail Type: Virtual Service Contact Details.",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"mapping": [{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}],
"kind": "complex-type",
"abstract": false,
"type": "VirtualServiceDetail",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation": "specialization",
"snapshot": {
"element": [{
"id": "VirtualServiceDetail",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "VirtualServiceDetail",
"short": "Virtual Service Contact Details",
"definition": "Virtual Service Contact Details.",
"min": 0,
"max": "*",
"base": {
"path": "VirtualServiceDetail",
"min": 0,
"max": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "VirtualServiceDetail.id",
"path": "VirtualServiceDetail.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "VirtualServiceDetail.extension",
"path": "VirtualServiceDetail.extension",
"slicing": {
"discriminator": [{
"type": "value",
"path": "url"
}],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "VirtualServiceDetail.channelType",
"path": "VirtualServiceDetail.channelType",
"short": "Channel Type",
"definition": "The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp).",
"comment": "As this type defines what the virtual service is, it then defines what address and additional information might be relevant.\n\nSome profiles could be used for specific types to define what the other values could/should be.",
"min": 0,
"max": "1",
"base": {
"path": "VirtualServiceDetail.channelType",
"min": 0,
"max": "1"
},
"type": [{
"code": "Coding"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VirtualServiceType"
}],
"strength": "example",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://hl7.org/fhir/ValueSet/virtual-service-type"
}
},
{
"id": "VirtualServiceDetail.address[x]",
"path": "VirtualServiceDetail.address[x]",
"short": "Contact address/number",
"definition": "What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).",
"min": 0,
"max": "1",
"base": {
"path": "VirtualServiceDetail.address[x]",
"min": 0,
"max": "1"
},
"type": [{
"code": "url"
},
{
"code": "string"
},
{
"code": "ContactPoint"
},
{
"code": "ExtendedContactDetail"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "VirtualServiceDetail.additionalInfo",
"path": "VirtualServiceDetail.additionalInfo",
"short": "Address to see alternative connection details",
"definition": "Address to see alternative connection details.",
"comment": "This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services.",
"min": 0,
"max": "*",
"base": {
"path": "VirtualServiceDetail.additionalInfo",
"min": 0,
"max": "*"
},
"type": [{
"code": "url"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "VirtualServiceDetail.maxParticipants",
"path": "VirtualServiceDetail.maxParticipants",
"short": "Maximum number of participants supported by the virtual service",
"definition": "Maximum number of participants supported by the virtual service.",
"comment": "Some services have only a limitted number of participants permitted to connect at a time, this is typically used in \"shared\" virtual services that you might find on location resources.\n\nTypically on-demand services might not have these restrictions.",
"min": 0,
"max": "1",
"base": {
"path": "VirtualServiceDetail.maxParticipants",
"min": 0,
"max": "1"
},
"type": [{
"code": "positiveInt"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
},
{
"id": "VirtualServiceDetail.sessionKey",
"path": "VirtualServiceDetail.sessionKey",
"short": "Session Key required by the virtual service",
"definition": "Session Key required by the virtual service.",
"comment": "Some services require a session key to be able to access the service once connected.\n\nThis could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call.",
"min": 0,
"max": "1",
"base": {
"path": "VirtualServiceDetail.sessionKey",
"min": 0,
"max": "1"
},
"type": [{
"code": "string"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true
}]
},
"differential": {
"element": [{
"id": "VirtualServiceDetail",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}],
"path": "VirtualServiceDetail",
"short": "Virtual Service Contact Details",
"definition": "Virtual Service Contact Details.",
"min": 0,
"max": "*"
},
{
"id": "VirtualServiceDetail.channelType",
"path": "VirtualServiceDetail.channelType",
"short": "Channel Type",
"definition": "The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp).",
"comment": "As this type defines what the virtual service is, it then defines what address and additional information might be relevant.\n\nSome profiles could be used for specific types to define what the other values could/should be.",
"min": 0,
"max": "1",
"type": [{
"code": "Coding"
}],
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The purpose for which an extended contact detail should be used."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VirtualServiceType"
}],
"strength": "example",
"description": "The purpose for which an extended contact detail should be used.",
"valueSet": "http://hl7.org/fhir/ValueSet/virtual-service-type"
}
},
{
"id": "VirtualServiceDetail.address[x]",
"path": "VirtualServiceDetail.address[x]",
"short": "Contact address/number",
"definition": "What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).",
"min": 0,
"max": "1",
"type": [{
"code": "url"
},
{
"code": "string"
},
{
"code": "ContactPoint"
},
{
"code": "ExtendedContactDetail"
}],
"isSummary": true
},
{
"id": "VirtualServiceDetail.additionalInfo",
"path": "VirtualServiceDetail.additionalInfo",
"short": "Address to see alternative connection details",
"definition": "Address to see alternative connection details.",
"comment": "This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services.",
"min": 0,
"max": "*",
"type": [{
"code": "url"
}],
"isSummary": true
},
{
"id": "VirtualServiceDetail.maxParticipants",
"path": "VirtualServiceDetail.maxParticipants",
"short": "Maximum number of participants supported by the virtual service",
"definition": "Maximum number of participants supported by the virtual service.",
"comment": "Some services have only a limitted number of participants permitted to connect at a time, this is typically used in \"shared\" virtual services that you might find on location resources.\n\nTypically on-demand services might not have these restrictions.",
"min": 0,
"max": "1",
"type": [{
"code": "positiveInt"
}],
"isSummary": true
},
{
"id": "VirtualServiceDetail.sessionKey",
"path": "VirtualServiceDetail.sessionKey",
"short": "Session Key required by the virtual service",
"definition": "Session Key required by the virtual service.",
"comment": "Some services require a session key to be able to access the service once connected.\n\nThis could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call.",
"min": 0,
"max": "1",
"type": [{
"code": "string"
}],
"isSummary": true
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/MoneyQuantity",
"resource": {
"resourceType": "StructureDefinition",
"id": "MoneyQuantity",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Datatype MoneyQuantity
An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision)
Rule
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.exists() or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}],
"url": "http://hl7.org/fhir/StructureDefinition/MoneyQuantity",
"version": "5.0.0",
"name": "MoneyQuantity",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision)",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"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",
"path": "Quantity",
"short": "An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision)",
"definition": "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).",
"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": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "mtqy-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.exists() or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')"
},
{
"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()",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,PQ, IVL, MO, CO, depending on the values"
},
{
"identity": "v2",
"map": "SN (see also Range) or CQ"
}]
},
{
"id": "Quantity.id",
"path": "Quantity.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Quantity.value",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "SN.2 / CQ - N/A"
},
{
"identity": "rim",
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
}]
},
{
"id": "Quantity.comparator",
"path": "Quantity.comparator",
"short": "< | <= | >= | > | ad - how to understand the value",
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.comparator",
"min": 0,
"max": "1"
},
"type": [{
"code": "code"
}],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How the Quantity should be understood and represented."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}]
},
{
"id": "Quantity.unit",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(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",
"base": {
"path": "Quantity.system",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "CO.codeSystem, PQ.translation.codeSystem"
}]
},
{
"id": "Quantity.code",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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": "An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision)",
"definition": "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).",
"min": 0,
"max": "*",
"constraint": [{
"key": "mtqy-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.exists() or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')"
}],
"isModifier": false
}]
}
}
},
{
"fullUrl": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity",
"resource": {
"resourceType": "StructureDefinition",
"id": "SimpleQuantity",
"meta": {
"lastUpdated": "2023-03-26T15:21:02.749+11:00"
},
"text": {
"status": "generated",
"div": "Datatype SimpleQuantity
A fixed quantity (no comparator)
Rule
The comparator is not used on a SimpleQuantity
Expression:
comparator.empty()
"
},
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}],
"url": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity",
"version": "5.0.0",
"name": "SimpleQuantity",
"status": "active",
"experimental": false,
"date": "2023-03-26T15:21:02+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [{
"telecom": [{
"system": "url",
"value": "http://hl7.org/fhir"
}]
}],
"description": "A fixed quantity (no comparator)",
"jurisdiction": [{
"coding": [{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}]
}],
"fhirVersion": "5.0.0",
"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",
"path": "Quantity",
"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": "*"
},
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "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()",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
},
{
"key": "sqty-1",
"severity": "error",
"human": "The comparator is not used on a SimpleQuantity",
"expression": "comparator.empty()"
}],
"isModifier": false,
"mapping": [{
"identity": "rim",
"map": "n/a,PQ, IVL, MO, CO, depending on the values"
},
{
"identity": "v2",
"map": "SN (see also Range) or CQ"
}]
},
{
"id": "Quantity.id",
"path": "Quantity.id",
"representation": ["xmlAttr"],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [{
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}],
"code": "http://hl7.org/fhirpath/System.String"
}],
"condition": ["ele-1"],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": ["extensions",
"user content"],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [{
"code": "Extension"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier": false,
"isSummary": false,
"mapping": [{
"identity": "rim",
"map": "n/a"
}]
},
{
"id": "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",
"base": {
"path": "Quantity.value",
"min": 0,
"max": "1"
},
"type": [{
"code": "decimal"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "SN.2 / CQ - N/A"
},
{
"identity": "rim",
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
}]
},
{
"id": "Quantity.comparator",
"path": "Quantity.comparator",
"short": "< | <= | >= | > | ad - how to understand the value",
"definition": "Not allowed to be used in this context",
"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",
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true,
"binding": {
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "How the Quantity should be understood and represented."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0"
},
"mapping": [{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}]
},
{
"id": "Quantity.unit",
"extension": [{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"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"
}],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(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",
"base": {
"path": "Quantity.system",
"min": 0,
"max": "1"
},
"type": [{
"code": "uri"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"isSummary": true,
"mapping": [{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "CO.codeSystem, PQ.translation.codeSystem"
}]
},
{
"id": "Quantity.code",
"extension": [{
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
}],
"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"
}],
"condition": ["qty-3"],
"constraint": [{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier": false,
"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 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()"
}],
"isModifier": false
},
{
"id": "Quantity.comparator",
"path": "Quantity.comparator",
"definition": "Not allowed to be used in this context",
"max": "0"
}]
}
}
}]
}