| Attachment |
| Definition | For referring to data content defined in other formats. |
| Control | 1..1 |
| Requirements | Many models need to include data defined in other specifications that is complex and opaque to the healthcare model. This includes documents, media recordings, structured data, etc. |
| RIM Mapping | ED |
| Attachment.contentType |
| 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 |
| Control | 1..1 |
| Type | code from MimeType |
| Must Understand | true |
| Requirements | Processors of the data need to be able to tell what the data is |
| RIM Mapping | ./mediaType, ./charset |
| Attachment.data |
| Definition | The actual data of the attachment - a sequence of bytes. In XML, represented using base64 |
| Control | 0..1 |
| Type | base64Binary |
| Must Understand | true |
| Requirements | The data needs to able to be transmitted inline |
| Comments | The base64-encoded data must be expressed in the same character set as the base resource XML |
| RIM Mapping | ./data |
| To Do | Should this be handled by an extension? How common is it? |
| Attachment.url |
| Definition | An alternative location where the data can be accessed |
| Control | 0..1 |
| Type | uri |
| Must Understand | true |
| Requirements | The data needs to be transmitted by reference |
| Comments | If both data and url are provided, the url must point to the same content as the data contains. Urls may be relative references or may be made to transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. If a URL is provided, it must resolve to actual data. |
| RIM Mapping | ./reference/literal |
| To Do | Sort out relative URL references |
| Attachment.size |
| Definition | The number of bytes of data that make up this attachment. |
| Control | 0..1 |
| Type | integer |
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all |
| Comments | 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 |
| RIM Mapping | (needs data type R3 proposal) |
| Attachment.hash |
| Definition | The calculated hash of the data using SHA-1. Represented using base64 |
| Control | 0..1 |
| Type | base64Binary |
| Requirements | Included so that applications can verify that the contents of a location have not changed, and also so that a signature of the xml content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature |
| RIM Mapping | .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"] |
| Attachment.title |
| Definition | A label or set of text to display in place of the data |
| Control | 0..1 |
| Type | string |
| 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. |
| RIM Mapping | ./title/data |
| Identifier |
| Definition | A technical identifier - identifies some entity uniquely and unambiguously |
| Control | 1..1 |
| Requirements | Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation |
| Comments | the Identifier class is a little looser than II because it allows URIs as well as registered OIDs or GUIDs |
| RIM Mapping | II |
| Identifier.system |
| Definition | Establishes the namespace in which set of possible id values is unique. |
| Control | 0..1 |
| Type | uri |
| Must Understand | true |
| Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. |
| RIM Mapping | II.root |
| Identifier.id |
| Definition | The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
| Control | 0..1 |
| Type | string |
| Must Understand | true |
| Comments | if the id is actually a full uri, then the system is urn:ietf:rfc:3986 |
| RIM Mapping | II.extension or II.root if system indicates OID or GUID |
| Coding |
| Definition | A reference to a code defined by a terminology system |
| Control | 1..1 |
| Requirements | Referring to codes is a ubiquitous task in healthcare models |
| Comments | Codes may defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED-CT - see the v3 core principles for more information |
| RIM Mapping | CV |
| Coding.system |
| Definition | The identification of the system that defines the meaning of the symbol in the code. Can be a simple list of enumerations, a list of codes with meanings or all the way to a complex semantic web such as SNOMED-CT, whether classification, terminology, or ontology |
| Control | 0..1 |
| Type | uri |
| Must Understand | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol |
| Comments | The identity is a uri. It may be an OID or a UUID, which must be references to the HL7 OID registry, or a URI which either comes from the list of FHIR defined special URIs, or from some system defined elsewhere, in which case the URI should de-reference to establish the system unambiguously |
| RIM Mapping | ./codeSystem |
| Coding.code |
| 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 |
| Control | 0..1 |
| Type | code |
| Must Understand | true |
| Requirements | Need to refer to a particular code in the system |
| RIM Mapping | ./code |
| Coding.display |
| Definition | A representation of the meaning of the code in the system, following the rules laid out by the system. |
| Control | 0..1 |
| Type | string |
| Requirements | Need to be able to carry a human readable meaning of the code for readers that do not recognise the system |
| RIM Mapping | CV.displayName |
| To Do | language? |
| CodeableConcept |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text |
| Control | 1..1 |
| Requirements | 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 |
| Comments | 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 |
| RIM Mapping | CD |
| CodeableConcept.coding |
| Definition | A reference to a code defined by a terminology system |
| Control | 0..* |
| Type | Coding |
| Must Understand | true |
| Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
| Comments | Codes may defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED-CT - see the v3 core principles for more information. Ordering of codings is undefined and must not be used to infer meaning. |
| RIM Mapping | union(., ./translation) |
| CodeableConcept.text |
| 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 or concept |
| Control | 0..1 |
| Type | string |
| Must Understand | true |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source |
| Comments | Very often the text is the same as a displayName of one of the codings |
| RIM Mapping | ./originalText[mediaType/code="text/plain"]/data |
| CodeableConcept.primary |
| Definition | Indicates which of the codes in the codings was chosen by a user, if one was chosen directly |
| Control | 0..1 |
| Type | idref |
| Requirements | Where a user picks an actual code directly, it is useful to note that this is the primary input. It's also the most appropriate starting point for new translations (unless re-coding directly from 'text'). |
| RIM Mapping | special("The id assigned to the coding that corresponds to the root code of the CD") |
| Choice |
| Definition | A code taken from a short list of codes that are not defined in a formal code system |
| Control | 1..1 |
| Requirements | Questionnaires and the like - assessment scales. There's no formal terminology underlying them, yet the possible choices affect the interpretation of the code. Because the choice can be quite dynamic, the price of setting up formal infrastructure to carry the choices out of band is expensive |
| Comments | Choice is generally used for things like pain scales, questionnaires or formally defined assessment indexes. The possible codes may be ordered with some arbitrarily defined scale. Choice does not fit all assessment scales - the more combinatorial the value is, the less likely that Choice will be an appropriate data type |
| RIM Mapping | CD |
| Choice.code |
| Definition | The code or value that the user selected from the list of possible codes |
| Control | 0..1 |
| Type | code |
| Must Understand | true |
| Comments | The "code" might be a numerical choice in a pain scale, for instance, 1 where the choices are 1-5 with associated words for severity of pain |
| RIM Mapping | CD.code |
| Choice.option |
| Definition | A list of possible values for the code |
| Control | 2..* |
| Must Understand | true |
| Requirements | Need to know the possible codes the user could have chosen |
| RIM Mapping | Expansion of CD.valueSet to list of CDs |
| Choice.option.code |
| Definition | A possible code or value that the user could have chosen |
| Control | 1..1 |
| Type | code |
| Must Understand | true |
| Requirements | Need to know the possible codes the user could have chosen |
| RIM Mapping | CD.code |
| Choice.option.display |
| Definition | A set of words associated with the code to give it meaning and displayed to the user |
| Control | 0..1 |
| Type | string |
| Requirements | Sometimes the codes have associated words that give it more meaning |
| Comments | The code itself may convey sufficient meaning |
| RIM Mapping | CD.displayName |
| Choice.isOrdered |
| Definition | Whether the order of the values has an assigned meaning |
| Control | 0..1 |
| Type | boolean |
| Must Understand | true |
| Requirements | The Choice may come from an ordered scale such as a pain scale or a an assessment scale, or it may be just a random set of choices that have no particular order |
| RIM Mapping | N/A |
| Quantity |
| 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 |
| Control | 1..1 |
| Requirements | 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, currencies such as $100.32USD |
| Comments | 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 status |
| RIM Mapping | PQ, IVL<PQ>, MO, CO, depending on the values |
| Quantity.value |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value |
| Control | 0..1 |
| Type | decimal |
| Must Understand | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement |
| Comments | The implicit precision should always be honored. Currency has its own rules for handling precision |
| RIM Mapping | PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value |
| Quantity.range |
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the measure due to measurement issues |
| Control | 0..1 |
| Type | code from QuantityRange |
| Must Understand | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| RIM Mapping | IVL properties |
| Quantity.units |
| Definition | A human readable form of the units |
| Control | 0..1 |
| Type | string |
| Must Understand | true |
| Requirements | There are lots of representations for the units and in many contexts, particular representations are fixed and required. i.e. mcg for micrograms, and not ug |
| RIM Mapping | N/A |
| Quantity.system |
| Definition | The identification of the system that provides the coded form of the unit |
| Control | 0..1 |
| Type | uri |
| Must Understand | true |
| Requirements | Need to know the system that defines the coded form of the unit |
| RIM Mapping | CO.codeSystem, PQ.translation.codeSystem |
| Quantity.code |
| Definition | A computer processable form of the units in some unit representation system |
| Control | 0..1 |
| Type | code |
| Must Understand | true |
| Requirements | Need a computable form of the units that is fixed across all forms. UCUM provides this for quantities, but SNOMED-CT provides many arbitrary units of interest |
| Comments | 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 (Unless the Quantity element has a dataAbsentReason flag) |
| RIM Mapping | PQ.code, MO.currency, PQ.translation.code |
| Range |
| Definition | A set of ordered Quantities defined by a low and high limit. |
| Control | 1..1 |
| Requirements | Need to be able to specify ranges of values or time periods |
| Comments | 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 |
| RIM Mapping | IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]> |
| Range.low |
| Definition | The low limit. The boundary is inclusive. |
| Control | 0..1 |
| Type | Quantity |
| Must Understand | true |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| RIM Mapping | ./low |
| Range.high |
| Definition | The high limit. The boundary is inclusive. |
| Control | 0..1 |
| Type | Quantity |
| Must Understand | true |
| Comments | If the high element is missing, the meaning is that the high boundary is not known. |
| RIM Mapping | ./high |
| Period |
| Definition | A time period defined by a start and end time. |
| Control | 1..1 |
| Comments | Not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If a duration might be required, specify the type as Interval|Duration |
| RIM Mapping | IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] |
| Period.start |
| Definition | The start of the period. The boundary is inclusive. |
| Control | 0..1 |
| Type | dateTime |
| Must Understand | true |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| RIM Mapping | ./low |
| Period.end |
| Definition | The end of the period. If the high is missing, it means that the period is ongoing |
| Control | 0..1 |
| Type | dateTime |
| Must Understand | true |
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03 |
| RIM Mapping | ./high |
| HumanId |
| Definition | An identifier that humans use. This is different from a system identifier because identifiers that humans use are regularly changed or retired due to human intervention and error. Note that a human identifier may be a system identifier on some master system but becomes a human identifier elsewhere due to how it is exchanged between humans. Driver's license numbers are a good example of this. Also, because human mediated identifiers are often invoked as implicit links to external business processes, such identifiers are often associated with multiple different resources. |
| Control | 1..1 |
| Requirements | Need to be able to work with the many vagaries of human identifiers - that is, identifiers that humans use for things, with the attendant uncertainty and correction features |
| HumanId.use |
| Definition | Identifies the use for this identifier, if known
|
| Control | 0..1 |
| Type | code from IdentifierUse |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers |
| HumanId.label |
| Definition | A label for the identifier that can be displayed to a human so they can recognise the identifier |
| Control | 0..1 |
| Type | string |
| Requirements | Allows humans to make use of identifiers when the identifier system is not known |
| HumanId.identifier |
| Definition | The identifier itself |
| Control | 0..1 |
| Type | Identifier |
| Must Understand | true |
| Requirements | Allows for matching of objects |
| HumanId.period |
| Definition | Time period during which identifier was valid for use |
| Control | 0..1 |
| Type | Period |
| HumanId.assigner |
| Definition | Organisation that issued/manages the identifier |
| Control | 0..1 |
| Type | Resource(Organization) |
| Comments | The reference may be just a text description of the assigner |
| HumanName |
| Definition | A human's name with the ability to identify parts and usage |
| Control | 1..1 |
| Requirements | Need to be able to record names, along with notes about their use |
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts, and the degree to which systems must care about name parts around the world varies widely. |
| RIM Mapping | EN |
| HumanName.use |
| Definition | Identifies the purpose for this name |
| Control | 0..1 |
| Type | code from NameUse |
| Must Understand | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names |
| RIM Mapping | unique(./use) |
| HumanName.text |
| Definition | a full text representation of the name |
| Control | 0..1 |
| Type | string |
| Requirements | A renderable, unencoded form |
| Comments | Can provide both a text representation, and structured parts |
| RIM Mapping | ./formatted |
| HumanName.family |
| Definition | Family name, this is the 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. |
| Control | 0..* |
| Type | string |
| Aliases | surname |
| Comments | family name is allowed to repeat. A single family name with spaces is equivalent to multiple family names with the same values |
| HumanName.given |
| Definition | Given name. NOTE: Not to be called "first name" since given names do not always come first. |
| Control | 0..* |
| Type | string |
| Aliases | first name; middle name |
| HumanName.prefix |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that comes at the start of the name |
| Control | 0..* |
| Type | string |
| HumanName.suffix |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that comes at the end of the name |
| Control | 0..* |
| Type | string |
| HumanName.period |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Control | 0..1 |
| Type | Period |
| Requirements | Allows names to be placed in historical context |
| RIM Mapping | ./usablePeriod[type="IVL<TS>"] |
| Address |
| Definition | There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for addresses all around the world |
| Control | 1..1 |
| Requirements | Need to be able to record postal addresses, along with notes about their use |
| Comments | Note: address is for postal addresses, not physical locations |
| RIM Mapping | AD |
| Address.use |
| Definition | Identifies the intended purpose of this address |
| Control | 0..1 |
| Type | code from AddressUse |
| Must Understand | true |
| Requirements | Allows an appropriate address to be chosen from a list of many |
| RIM Mapping | unique(./use) |
| Address.text |
| Definition | a full text representation of the address |
| Control | 0..1 |
| Type | string |
| Must Understand | true |
| Requirements | A renderable, unencoded form |
| Comments | Can provide both a text representation, and parts |
| RIM Mapping | ./formatted |
| Address.part |
| Definition | Part of an address line |
| Control | 0..* |
| Type | string |
| Comments | an extension may further define the meaning of the part |
| Address.line |
| Definition | A line of an address (typically used for street names & numbers, unit details, delivery hints, etc.) . |
| Control | 0..* |
| Type | string |
| Address.city |
| Definition | The name of the city, town, village, or other community or delivery centre. |
| Control | 0..1 |
| Type | string |
| Address.state |
| Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). |
| Control | 0..1 |
| Type | string |
| Address.zip |
| Definition | A postal code designating a region defined by the postal service. |
| Control | 0..1 |
| Type | string |
| Address.country |
| Definition | Country. ISO 3166 3 letter codes can be used in place of a full country name. |
| Control | 0..1 |
| Type | string |
| Address.dpid |
| Definition | A value that uniquely identifies the postal address. (Often used in barcodes). |
| Control | 0..1 |
| Type | string |
| Address.period |
| Definition | Time period when address was/is in use |
| Control | 0..1 |
| Type | Period |
| Requirements | Allows addresses to be placed in historical context |
| RIM Mapping | ./usablePeriod[type="IVL<TS>"] |
| Contact |
| Definition | All kinds of technology mediated contact details for a person or organisation, including telephone, email, etc. |
| Control | 1..1 |
| Requirements | Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc. |
| RIM Mapping | TEL |
| Contact.system |
| Definition | What kind of contact this is - what communications system is required to make use of the contact |
| Control | 0..1 |
| Type | code from ContactSystem |
| Must Understand | true |
| RIM Mapping | ./scheme |
| Contact.value |
| Definition | The actual contact details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
| Control | 0..1 |
| Type | string |
| Must Understand | true |
| Requirements | Need to support legacy numbers that are not in a tightly controlled format |
| Comments | additional out of band data such as extensions, or notes about use of the contact are sometimes included in the value |
| RIM Mapping | ./url |
| Contact.use |
| Definition | Identifies the context for the address |
| Control | 0..1 |
| Type | code from ContactUse |
| Must Understand | true |
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose |
| RIM Mapping | unique(./use) |
| Contact.period |
| Definition | Time period when the contact was/is in use |
| Control | 0..1 |
| Type | Period |
| RIM Mapping | ./useablePeriod[type="IVL<TS>"] |
| Schedule |
| Definition | A schedule that specifies an event that may occur multiple times. Schedules are not used for recording when things did happen, but when they are expected or requested to occur. |
| Control | 1..1 |
| Requirements | Need to able to track schedules. There are several different ways to do scheduling: one or more specified times, a simple rules like three times a day, or to say, x before/after meals, or something like that |
| Comments | A schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. |
| RIM Mapping | GTS |
| Schedule.event |
| Definition | Identifies specific time periods when the event should occur |
| Control | 0..* |
| Type | Period |
| Must Understand | true |
| Requirements | Some schedules are just explicit lists of times |
| Schedule.repeat |
| Definition | Identifies a repeating pattern to the intended time periods. |
| Control | 0..1 |
| Must Understand | true |
| Requirements | Many schedules are determined by regular repetitions |
| Comments | If present, the Schedule.event indicates the time of the first occurrence. |
| Schedule.repeat.frequency |
| Definition | Indicates how often the event should occur. |
| Control | 0..1 |
| Type | integer |
| Must Understand | true |
| Schedule.repeat.when |
| Definition | Identifies the occurrence of daily life that determine timing |
| Control | 0..1 |
| Type | code from EventTiming |
| Must Understand | true |
| Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep |
| Schedule.repeat.duration |
| Definition | How long each repetition should last |
| Control | 1..1 |
| Type | decimal |
| Must Understand | true |
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time |
| Schedule.repeat.units |
| Definition | the units of time for the duration |
| Control | 1..1 |
| Type | code from UnitsOfTime |
| Must Understand | true |
| Schedule.repeat.count |
| Definition | A total count of the desired number of repetitions |
| Control | 0..1 |
| Type | integer |
| Must Understand | true |
| Requirements | Repetitions may be limited by end time or total occurrences |
| Comments | An end need not be specified |
| Schedule.repeat.end |
| Definition | When to stop repeats |
| Control | 0..1 |
| Type | dateTime |
| Must Understand | true |
| Requirements | Repetitions may be limited by end time or total occurrences |
| Comments | An end need not be specified |
. Page versions: R5 R4B R4 R3 R2