For referring to data content defined in other formats.

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.

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".

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.

Processors of the data need to be able to know how to interpret the data.

The human language of the content. The value can be any valid value according to BCP 47.

Users need to be able to choose between the languages in a set of attachments.

The actual data of the attachment - a sequence of bytes, base64 encoded.

The data needs to able to be transmitted inline.

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

A location where the data can be accessed.

The data needs to be transmitted by reference.

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.

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

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.

The calculated hash of the data using SHA-1. Represented using base64.

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).

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 for mechanism to protect a resource with a digital signature.

A label or set of text to display in place of the data.

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.

May sometimes be derived from the source filename.

The date that the attachment was first created.

This is often tracked as an integrity issue for use of the attachment.

Height of the image in pixels (photo/video).

Width of the image in pixels (photo/video).

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.

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.

The duration of the recording in seconds - for audio and video.

The duration might differ from occurrencePeriod if recording was paused.

The number of pages when printed.

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation.

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.

The purpose of this identifier.

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Allows users to make use of identifiers when the identifier system is not known.

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.

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

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.

Identifier.system is always case sensitive.

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

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). 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.

Time period during which identifier is/was valid for use.

Organization that issued/manages the identifier.

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.

A reference to a code defined by a terminology system.

References to codes are very common in healthcare models.

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.

The identification of the code system that defines the meaning of the symbol in the code.

Need to be unambiguous about the source of the definition of the symbol.

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.

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.

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.

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).

Need to refer to a particular code in the system.

A representation of the meaning of the code in the system, following the rules of the system.

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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.

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.

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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.

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.

A reference to a code defined by a terminology system.

Allows for alternative encodings within a code system, and translations to other code systems.

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.

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.

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.

Very often the text is the same as a displayName of one of the codings.

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.

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.

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.

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Precision is handled implicitly in almost all cases of measurement.

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).

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.

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

A human-readable form of the unit.

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

The identification of the system that provides the coded form of the unit.

Need to know the system that defines the coded form of the unit.

A computer processable form of the unit in some unit representation system.

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.

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.

An amount of economic utility in some recognized currency.

Numerical value (with implicit precision).

The amount of the currency. The value includes an implicit precision in the presentation of the value.

Monetary values have their own rules for handling precision (refer to standard accounting text books).

ISO 4217 Currency Code.

A code indicating the currency, taken from ISO 4217.

A set of ordered Quantities defined by a low and high limit.

Need to be able to specify ranges of values.

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.

The low limit. The boundary is inclusive.

If the low element is missing, the low boundary is not known.

The high limit. The boundary is inclusive.

If the high element is missing, the high boundary is not known.

A relationship of two Quantity values - expressed as a numerator and a denominator.

Need to able to capture ratios for some measurements (titers) and some rates (costs).

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.

The value of the numerator.

The value of the denominator.

A range of ratios expressed as a low and high numerator and a denominator.

Need to be able to specify ranges of ratios.

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.

The value of the low limit numerator.

If the low element is missing, the low boundary is not known.

The value of the high limit numerator.

If the high element is missing, the high boundary is not known.

The value of the denominator.

A time period defined by a start and end date and optionally 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").

Period is not used for a duration (a measure of elapsed time). See Duration.

The start of the period. The boundary is inclusive.

If the low element is missing, the meaning is that the low boundary is not known.

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.

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.

A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

There is a need for a concise way to handle the data produced by devices that sample a physical state at a high frequency.

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".

The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.

Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.

This is usually a whole number.

The measurement unit in which the sample interval is expressed.

A correction factor that is applied to the sampled data points before they are added to the origin.

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).

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).

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.

If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data).

Reference to ConceptMap that defines the codes used in the data.

The ConceptMap cannot define meanings for the codes 'E', 'U', or 'L' (nor 'e', 'u', or 'l').

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.

If offsets is present, the number of data points must be equal to the number of offsets mlutipled by the dimensions.

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.

The data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData.

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.

Need to be able to record names, along with notes about their use.

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.

Identifies the purpose for this name.

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

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.

A renderable, unencoded form.

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.

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.

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Given name.

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.

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.

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.

Indicates the period of time when this name was valid for the named person.

Allows names to be placed in historical context.

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

Need to be able to record postal addresses, along with notes about their use.

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

The purpose of this address.

Allows an appropriate address to be chosen from a list of many.

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

A renderable, unencoded form.

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

The name of the city, town, suburb, village or other community or delivery center.

The name of the administrative area (county).

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

A postal code designating a region defined by the postal service.

Country - a nation as commonly understood or generally accepted.

ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

Time period when address was/is in use.

Allows addresses to be placed in historical context.

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc.

Telecommunications form for contact point - what communications system is required to make use of the contact.

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Need to support legacy numbers that are not in a tightly controlled format.

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Identifies the purpose for the contact point.

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

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.

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Ranks 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.

Ranks 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.

Time period when the contact point was/is in use.

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.

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.

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.

A 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.

Identifies specific times when the event occurs.

In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

A set of rules that describe when the event is scheduled.

Many timing schedules are determined by regular repetitions.

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.

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.

Repetitions may be limited by end time or total occurrences.

If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

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.

Some activities are not instantaneous and need to be maintained for a period of time.

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).

If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

Some activities are not instantaneous and need to be maintained for a period of time.

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).

The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.

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.

If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

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.

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.

The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.

If one or more days of week is provided, then the action happens only on the specified day(s).

If no days are specified, the action is assumed to happen every day as otherwise specified.

Specified time of day for action to take place.

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.

An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

Timings are frequently determined by occurrences such as waking, eating and sleep.

When more than one event is listed, the event is tied to the union of the specified events.

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.

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).

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).

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.

There are a number of places where content must be signed in healthcare.

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.

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.

Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a &quot;Commitment Type Indication&quot;.

When the digital signature was signed.

This should agree with the information in the signature.

A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

This should agree with the information in the signature.

A reference to an application-usable description of the identity that is represented by the signature.

used when the signature is on behalf of a non-signer.

The party that can't sign. For example a child.

A mime type that indicates the technical format of the target resources signed by the signature.

"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.

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.

The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.

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.

A text note which also contains information about who made the statement and when.

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

The individual responsible for making the annotation.

Organization is used when there's no need for specific attribution as to who made the comment.

Indicates when this particular annotation was made.

The text of the annotation in markdown format.