Base StructureDefinition for Element Type: Base definition for all elements in a resource.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Element | Base for all elements | Base definition for all elements in a resource. | |
| Element.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Element.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.
| Path | Short | Definition | Comments |
|---|---|---|---|
| BackboneElement | Base for elements defined inside a resource | Base definition for all elements that are defined inside a resource - but not those in a data type. | |
| BackboneElement.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| BackboneElement.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| BackboneElement.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
Base StructureDefinition for base64Binary Type: A stream of bytes
| Path | Short | Definition | Comments |
|---|---|---|---|
| base64Binary | Primitive Type base64Binary | A stream of bytes | A stream of bytes, base64 encoded |
| base64Binary.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| base64Binary.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| base64Binary.value | Primitive value for base64Binary | The actual value |
Base StructureDefinition for boolean Type: Value of "true" or "false"
| Path | Short | Definition | Comments |
|---|---|---|---|
| boolean | Primitive Type boolean | Value of "true" or "false" | |
| boolean.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| boolean.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| boolean.value | Primitive value for boolean | The actual value |
Base StructureDefinition for canonical type: A URI that is a reference to a canonical URL on a FHIR resource
| Path | Short | Definition | Comments |
|---|---|---|---|
| canonical | Primitive Type canonical | A URI that is a reference to a canonical URL on a FHIR resource | see [Canonical References](references.html#canonical) |
| canonical.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| canonical.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| canonical.value | Primitive value for canonical | Primitive value for canonical |
Base StructureDefinition for code type: A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
| Path | Short | Definition | Comments |
|---|---|---|---|
| code | Primitive Type code | A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents | |
| code.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| code.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| code.value | Primitive value for code | Primitive value for code |
Base StructureDefinition for date Type: A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
| Path | Short | Definition | Comments |
|---|---|---|---|
| date | Primitive Type date | A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates. | |
| date.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| date.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| date.value | Primitive value for date | The actual value |
Base StructureDefinition for dateTime Type: A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
| Path | Short | Definition | Comments |
|---|---|---|---|
| dateTime | Primitive Type dateTime | A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. | |
| dateTime.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| dateTime.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| dateTime.value | Primitive value for dateTime | The actual value |
Base StructureDefinition for decimal Type: A rational number with implicit precision
| Path | Short | Definition | Comments |
|---|---|---|---|
| decimal | Primitive Type decimal | A rational number with implicit precision | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
| decimal.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| decimal.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| decimal.value | Primitive value for decimal | The actual value |
Base StructureDefinition for id type: Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
| Path | Short | Definition | Comments |
|---|---|---|---|
| id | Primitive Type id | Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. | RFC 4122 |
| id.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| id.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| id.value | Primitive value for id | Primitive value for id |
Base StructureDefinition for instant Type: An instant in time - known at least to the second
| Path | Short | Definition | Comments |
|---|---|---|---|
| instant | Primitive Type instant | An instant in time - known at least to the second | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required |
| instant.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| instant.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| instant.value | Primitive value for instant | The actual value |
Base StructureDefinition for integer Type: A whole number
| Path | Short | Definition | Comments |
|---|---|---|---|
| integer | Primitive Type integer | A whole number | 32 bit number; for values larger than this, use decimal |
| integer.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| integer.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| integer.value | Primitive value for integer | The actual value |
Base StructureDefinition for markdown type: A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
| Path | Short | Definition | Comments |
|---|---|---|---|
| markdown | Primitive Type markdown | A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ |
| markdown.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| markdown.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| markdown.value | Primitive value for markdown | Primitive value for markdown |
Base StructureDefinition for oid type: An OID represented as a URI
| Path | Short | Definition | Comments |
|---|---|---|---|
| oid | Primitive Type oid | An OID represented as a URI | RFC 3001. See also ISO/IEC 8824:1990 € |
| oid.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| oid.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| oid.value | Primitive value for oid | Primitive value for oid |
Base StructureDefinition for positiveInt type: An integer with a value that is positive (e.g. >0)
| Path | Short | Definition | Comments |
|---|---|---|---|
| positiveInt | Primitive Type positiveInt | An integer with a value that is positive (e.g. >0) | |
| positiveInt.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| positiveInt.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| positiveInt.value | Primitive value for positiveInt | Primitive value for positiveInt |
Base StructureDefinition for string Type: A sequence of Unicode characters
| Path | Short | Definition | Comments |
|---|---|---|---|
| string | Primitive Type string | A sequence of Unicode characters | Note that FHIR strings SHALL NOT exceed 1MB in size |
| string.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| string.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| string.value | Primitive value for string | The actual value |
Base StructureDefinition for time Type: A time during the day, with no date specified
| Path | Short | Definition | Comments |
|---|---|---|---|
| time | Primitive Type time | A time during the day, with no date specified | |
| time.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| time.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| time.value | Primitive value for time | The actual value |
Base StructureDefinition for unsignedInt type: An integer with a value that is not negative (e.g. >= 0)
| Path | Short | Definition | Comments |
|---|---|---|---|
| unsignedInt | Primitive Type unsignedInt | An integer with a value that is not negative (e.g. >= 0) | |
| unsignedInt.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| unsignedInt.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| unsignedInt.value | Primitive value for unsignedInt | Primitive value for unsignedInt |
Base StructureDefinition for uri Type: String of characters used to identify a name or a resource
| Path | Short | Definition | Comments |
|---|---|---|---|
| uri | Primitive Type uri | String of characters used to identify a name or a resource | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| uri.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| uri.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| uri.value | Primitive value for uri | The actual value |
Base StructureDefinition for url type: A URI that is a literal reference
| Path | Short | Definition | Comments |
|---|---|---|---|
| url | Primitive Type url | A URI that is a literal reference | |
| url.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| url.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| url.value | Primitive value for url | Primitive value for url |
Base StructureDefinition for uuid type: A UUID, represented as a URI
| Path | Short | Definition | Comments |
|---|---|---|---|
| uuid | Primitive Type uuid | A UUID, represented as a URI | See The Open Group, CDE 1.1 Remote Procedure Call specification, Appendix A. |
| uuid.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| uuid.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| uuid.value | Primitive value for uuid | Primitive value for uuid |
Base StructureDefinition for xhtml Type
| Path | Short | Definition | Comments |
|---|---|---|---|
| xhtml | Primitive Type xhtml | XHTML | |
| xhtml.id | xml:id (or equivalent in JSON) | unique id for the element within a resource (for internal references) | |
| xhtml.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | 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. |
| xhtml.value | Actual xhtml | Actual xhtml |
Base StructureDefinition for Address Type: 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | 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. | 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](location.html#) resource). |
| Address.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Address.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Address.use | home | work | temp | old | billing - purpose of this address | The purpose of this address. | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Address.type | postal | physical | both | 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](location.html#) resource). |
| Address.text | Text representation of the address | 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. | 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. |
| Address.line | Street name, number, direction & P.O. Box etc. | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | |
| Address.city | Name of city, town etc. | The name of the city, town, suburb, village or other community or delivery center. | |
| Address.district | District name (aka county) | 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. |
| Address.state | Sub-unit of country (abbreviations ok) | 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). | |
| Address.postalCode | Postal code for area | A postal code designating a region defined by the postal service. | |
| Address.country | Country (e.g. can be ISO 3166 2 or 3 letter code) | Country - a nation as commonly understood or generally accepted. | ISO 3166 3 letter codes can be used in place of a human readable country name. |
| Address.period | Time period when address was/is in use | Time period when address was/is in use. |
Base StructureDefinition for Age Type: A duration of time during which an organism (or a process) has existed.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Age | A duration of time during which an organism (or a process) has existed | A duration of time during which an organism (or a process) has existed. | 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. |
| Age.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Age.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Age.value | Numerical value (with implicit precision) | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | 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). |
| Age.comparator | < | <= | >= | > - how to understand the value | 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. | |
| Age.unit | Unit representation | A human-readable form of the unit. | |
| Age.system | System that defines coded unit form | The identification of the system that provides the coded form of the unit. | |
| Age.code | Coded form of the unit | A computer processable form of the unit in some unit representation system. | 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. |
Base StructureDefinition for Annotation Type: A text note which also contains information about who made the statement and when.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Annotation | Text node with attribution | 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). |
| Annotation.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Annotation.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Annotation.author[x] | Individual responsible for the annotation | The individual responsible for making the annotation. | Organization is used when there's no need for specific attribution as to who made the comment. |
| Annotation.time | When the annotation was made | Indicates when this particular annotation was made. | |
| Annotation.text | The annotation - text content (as markdown) | The text of the annotation in markdown format. |
Base StructureDefinition for Attachment Type: For referring to data content defined in other formats.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Attachment | Content in a format defined elsewhere | For referring to data content defined in other formats. | 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". |
| Attachment.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Attachment.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Attachment.contentType | Mime type of the content, with charset etc. | 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. | |
| Attachment.language | Human language of the content (BCP-47) | The human language of the content. The value can be any valid value according to BCP 47. | |
| Attachment.data | Data inline, base64ed | The actual data of the attachment - a sequence of bytes, base64 encoded. | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
| Attachment.url | Uri where the data can be found | A location where the data can be accessed. | 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. |
| Attachment.size | Number of bytes of content (if url provided) | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). | 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. |
| Attachment.hash | Hash of the data (sha-1, base64ed) | The calculated hash of the data using SHA-1. Represented using base64. | 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. |
| Attachment.title | Label to display in place of the data | A label or set of text to display in place of the data. | |
| Attachment.creation | Date attachment was first created | The date that the attachment was first created. |
Base StructureDefinition for CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
| Path | Short | Definition | Comments |
|---|---|---|---|
| CodeableConcept | Concept - reference to a terminology or just text | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | 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. |
| CodeableConcept.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| CodeableConcept.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| CodeableConcept.coding | Code defined by a terminology system | A reference to a code defined by a terminology system. | 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. |
| CodeableConcept.text | Plain text representation of the concept | 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. | Very often the text is the same as a displayName of one of the codings. |
Base StructureDefinition for Coding Type: A reference to a code defined by a terminology system.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Coding | A reference to a code defined by a terminology system | A reference to a code defined by a terminology system. | 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. |
| Coding.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Coding.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Coding.system | Identity of the terminology system | The identification of the code system that defines the meaning of the symbol in the code. | 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 reference to some definition that establishes the system clearly and unambiguously. |
| Coding.version | Version of the system - if relevant | 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. |
| Coding.code | Symbol in syntax defined by the system | 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). | |
| Coding.display | Representation defined by the system | A representation of the meaning of the code in the system, following the rules of the system. | |
| Coding.userSelected | If this coding was chosen directly by the user | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | 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. |
Base StructureDefinition for ContactDetail Type: Specifies contact information for a person or organization.
| Path | Short | Definition | Comments |
|---|---|---|---|
| ContactDetail | Contact information | Specifies contact information for a person or organization. | |
| ContactDetail.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ContactDetail.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ContactDetail.name | Name of an individual to contact | The name of an individual to contact. | If there is no named individual, the telecom information is for the organization as a whole. |
| ContactDetail.telecom | Contact details for individual or organization | The contact details for the individual (if a name was provided) or the organization. |
Base StructureDefinition for ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
| Path | Short | Definition | Comments |
|---|---|---|---|
| ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | |
| ContactPoint.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ContactPoint.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ContactPoint.system | phone | fax | email | pager | url | sms | other | Telecommunications form for contact point - what communications system is required to make use of the contact. | |
| ContactPoint.value | The actual contact point details | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
| ContactPoint.use | home | work | temp | old | mobile - purpose of this contact point | Identifies the purpose for the contact point. | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
| ContactPoint.rank | Specify preferred order of use (1 = highest) | 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. |
| ContactPoint.period | Time period when the contact point was/is in use | Time period when the contact point was/is in use. |
Base StructureDefinition for Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Contributor | Contributor information | A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers. | |
| Contributor.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Contributor.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Contributor.type | author | editor | reviewer | endorser | The type of contributor. | |
| Contributor.name | Who contributed the content | The name of the individual or organization responsible for the contribution. | |
| Contributor.contact | Contact details of the contributor | Contact details to assist a user in finding and communicating with the contributor. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Count | A measured or measurable amount | 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. | 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. |
| Count.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Count.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Count.value | Numerical value (with implicit precision) | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | 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). |
| Count.comparator | < | <= | >= | > - how to understand the value | 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. | |
| Count.unit | Unit representation | A human-readable form of the unit. | |
| Count.system | System that defines coded unit form | The identification of the system that provides the coded form of the unit. | |
| Count.code | Coded form of the unit | A computer processable form of the unit in some unit representation system. | 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. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| DataRequirement | Describes a required data item | Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data. | |
| DataRequirement.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| DataRequirement.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| DataRequirement.type | The type of the required data | 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. | |
| DataRequirement.profile | The profile of the required data | The profile of the required data, specified as the uri of the profile definition. | |
| DataRequirement.subject[x] | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. | 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. |
| DataRequirement.mustSupport | Indicates specific structure elements that are referenced by the knowledge module | 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. The value of mustSupport SHALL be a FHIRPath resolveable 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). | |
| DataRequirement.codeFilter | What codes are expected | 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. | |
| DataRequirement.codeFilter.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| DataRequirement.codeFilter.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| DataRequirement.codeFilter.path | A code-valued attribute to filter on | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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. | The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation. |
| DataRequirement.codeFilter.searchParam | A coded (token) parameter to search on | 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. | |
| DataRequirement.codeFilter.valueSet | Valueset for the filter | 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. | |
| DataRequirement.codeFilter.code | What code is expected | 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. | |
| DataRequirement.dateFilter | What dates/date ranges are expected | 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. | |
| DataRequirement.dateFilter.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| DataRequirement.dateFilter.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| DataRequirement.dateFilter.path | A date-valued attribute to filter on | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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. | The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation. |
| DataRequirement.dateFilter.searchParam | A date valued parameter to search on | 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. | |
| DataRequirement.dateFilter.value[x] | The value of the filter, as a Period, DateTime, or Duration value | 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. | |
| DataRequirement.limit | Number of results | Specifies a maximum number of results that are required (uses the _count search parameter). | 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". |
| DataRequirement.sort | Order of the results | Specifies the order of the results to be returned. | 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. |
| DataRequirement.sort.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| DataRequirement.sort.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| DataRequirement.sort.path | The name of the attribute to perform the sort | 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. | |
| DataRequirement.sort.direction | ascending | descending | The direction of the sort, ascending or descending. |
Base StructureDefinition for Distance Type: A length - a value with a unit that is a physical distance.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Distance | A length - a value with a unit that is a physical distance | A length - a value with a unit that is a physical distance. | 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. |
| Distance.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Distance.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Distance.value | Numerical value (with implicit precision) | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | 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). |
| Distance.comparator | < | <= | >= | > - how to understand the value | 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. | |
| Distance.unit | Unit representation | A human-readable form of the unit. | |
| Distance.system | System that defines coded unit form | The identification of the system that provides the coded form of the unit. | |
| Distance.code | Coded form of the unit | A computer processable form of the unit in some unit representation system. | 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. |
Base StructureDefinition for Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Dosage | How the medication is/was taken or should be taken | Indicates how the medication is/was taken or should be taken by the patient. | |
| Dosage.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Dosage.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Dosage.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| Dosage.sequence | The order of the dosage instructions | Indicates the order in which the dosage instructions should be applied or interpreted. | |
| Dosage.text | Free text dosage instructions e.g. SIG | Free text dosage instructions e.g. SIG. | |
| Dosage.additionalInstruction | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | 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"). | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text. |
| Dosage.patientInstruction | Patient or consumer oriented instructions | Instructions in terms that are understood by the patient or consumer. | |
| Dosage.timing | When medication should be administered | When medication should be administered. | 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. |
| Dosage.asNeeded[x] | Take "as needed" (for x) | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". |
| Dosage.site | Body site to administer to | Body site to administer to. | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both. |
| Dosage.route | How drug should enter body | How drug should enter body. | |
| Dosage.method | Technique for administering medication | Technique for administering medication. | Terminologies used often pre-coordinate this term with the route and or form of administration. |
| Dosage.doseAndRate | Amount of medication administered | The amount of medication administered. | |
| Dosage.doseAndRate.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Dosage.doseAndRate.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Dosage.doseAndRate.type | The kind of dose or rate specified | The kind of dose or rate specified, for example, ordered or calculated. | |
| Dosage.doseAndRate.dose[x] | Amount of medication per dose | Amount of medication per dose. | 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. |
| Dosage.doseAndRate.rate[x] | Amount of medication per unit of time | Amount of medication per unit of time. | 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. It 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 grammer 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. |
| Dosage.maxDosePerPeriod | Upper limit on medication per unit of time | Upper limit on medication per unit of time. | 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". |
| Dosage.maxDosePerAdministration | Upper limit on medication per administration | Upper limit on medication per administration. | 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. |
| Dosage.maxDosePerLifetime | Upper limit on medication per lifetime of the patient | Upper limit on medication per lifetime of the patient. |
Base StructureDefinition for Duration Type: A length of time.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Duration | A length of time | A length of time. | 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. |
| Duration.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Duration.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Duration.value | Numerical value (with implicit precision) | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | 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). |
| Duration.comparator | < | <= | >= | > - how to understand the value | 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. | |
| Duration.unit | Unit representation | A human-readable form of the unit. | |
| Duration.system | System that defines coded unit form | The identification of the system that provides the coded form of the unit. | |
| Duration.code | Coded form of the unit | A computer processable form of the unit in some unit representation system. | 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. |
Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.
| Path | Short | Definition | Comments |
|---|---|---|---|
| ElementDefinition | Definition of an element in a resource or extension | Captures constraints on each element within the resource, profile, or extension. | |
| ElementDefinition.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| ElementDefinition.path | Path of the element in the hierarchy of elements | The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension. | |
| ElementDefinition.representation | xmlAttr | xmlText | typeAttr | cdaText | xhtml | Codes that define how this element is represented in instances, when the deviation varies from the normal case. | 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.). |
| ElementDefinition.sliceName | Name for this particular element (in a set of slices) | 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. | 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.). |
| ElementDefinition.sliceIsConstraining | If this slice definition constrains an inherited slice definition (or not) | 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. | 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. |
| ElementDefinition.label | Name for element to display with or prompt for element | 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. | See also the extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-question)[extension-elementdefinition-question.html]. |
| ElementDefinition.code | Corresponding codes in terminologies | A code that has the same meaning as the element in a particular terminology. | 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. |
| ElementDefinition.slicing | This element is sliced - slices follow | 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). | 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. |
| ElementDefinition.slicing.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.slicing.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.slicing.discriminator | Element values that are used to distinguish the slices | 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. | If there is no discriminator, the content is hard to process, so this should be avoided. |
| ElementDefinition.slicing.discriminator.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.slicing.discriminator.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.slicing.discriminator.type | value | exists | pattern | type | profile | How the element value is interpreted when discrimination is evaluated. | |
| ElementDefinition.slicing.discriminator.path | Path to element value | A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based. | The only FHIRPath functions that are allowed are as(type), resolve(), and extension(url). |
| ElementDefinition.slicing.description | Text description of how slicing works (or not) | 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. | If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable. |
| ElementDefinition.slicing.ordered | If elements must be in same order as slices | If the matching elements have to occur in the same order as defined in the profile. | 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. |
| ElementDefinition.slicing.rules | closed | open | openAtEnd | 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. | 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. |
| ElementDefinition.short | Concise definition for space-constrained presentation | A concise description of what this element means (e.g. for use in autogenerated summaries). | 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. |
| ElementDefinition.definition | Full formal definition as narrative text | 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). | 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. |
| ElementDefinition.comment | Comments about the use of this element | 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). | If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element. |
| ElementDefinition.requirements | Why this resource has been created | 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. | 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. |
| ElementDefinition.alias | Other names | Identifies additional names by which this element might also be known. | |
| ElementDefinition.min | Minimum Cardinality | The minimum number of times this element SHALL appear in the instance. | |
| ElementDefinition.max | Maximum Cardinality (a number or *) | The maximum number of times this element is permitted to appear in the instance. | |
| ElementDefinition.base | Base definition information for tools | 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 - i.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. | 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. |
| ElementDefinition.base.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.base.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.base.path | Path that identifies the base element | 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. | |
| ElementDefinition.base.min | Min cardinality of the base element | Minimum cardinality of the base element identified by the path. | 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). |
| ElementDefinition.base.max | Max cardinality of the base element | Maximum cardinality of the base element identified by the path. | 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. |
| ElementDefinition.contentReference | Reference to definition of content for the element | 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. | ContentReferences can only be defined in specializations, not constrained types, and they cannot be changed and always reference the non-constrained definition. |
| ElementDefinition.type | Data type and Profile for this element | The data type or resource that the value of this element is permitted to be. | 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). |
| ElementDefinition.type.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.type.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.type.code | Data type or Resource (reference to 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. | 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). |
| ElementDefinition.type.profile | Profiles (StructureDefinition or IG) - one must apply | 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. | It is possible to profile backbone element (e.g. part of a resource), using the [profile-element](extension-elementdefinition-profile-element.html) extension. |
| ElementDefinition.type.targetProfile | Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply | 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. | |
| ElementDefinition.type.aggregation | contained | referenced | bundled - how aggregated | 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. | See [Aggregation Rules](elementdefinition.html#aggregation) for further clarification. |
| ElementDefinition.type.versioning | either | independent | specific | Whether this reference needs to be version specific or version independent, or whether either can be used. | 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. |
| ElementDefinition.defaultValue[x] | Specified value if missing from instance | 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'). | 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. No 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. |
| ElementDefinition.meaningWhenMissing | Implicit meaning when this element is missing | The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'). | 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. |
| ElementDefinition.orderMeaning | What the order of the elements means | 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. | 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. |
| ElementDefinition.fixed[x] | Value must be exactly this | Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. | This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display. |
| ElementDefinition.pattern[x] | Value must have at least these property values | Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When 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., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. | 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]. |
| ElementDefinition.example | Example value (as defined for type) | A sample value for this element demonstrating the type of information that would typically be found in the element. | 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. |
| ElementDefinition.example.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.example.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.example.label | Describes the purpose of this example | Describes the purpose of this example amoung the set of examples. | |
| ElementDefinition.example.value[x] | Value of Example (one of allowed types) | The actual value for the element, which must be one of the types allowed for this element. | |
| ElementDefinition.minValue[x] | Minimum Allowed Value (for some types) | 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. | 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 an canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g. |
| ElementDefinition.maxValue[x] | Maximum Allowed Value (for some types) | 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. | 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 an canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg. |
| ElementDefinition.maxLength | Max length for strings | 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. | 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. |
| ElementDefinition.condition | Reference to invariant about presence | A reference to an invariant that may make additional statements about the cardinality or value in the instance. | |
| ElementDefinition.constraint | Condition that must evaluate to true | Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance. | Constraints should be declared on the "context" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint. |
| ElementDefinition.constraint.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.constraint.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.constraint.key | Target of 'condition' reference above | Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality. | |
| ElementDefinition.constraint.requirements | Why this constraint is necessary or appropriate | Description of why this constraint is necessary or appropriate. | To be used if the reason for the constraint might not be intuitive to all implementers. |
| ElementDefinition.constraint.severity | error | warning | Identifies the impact constraint violation has on the conformance of the instance. | This allows constraints to be asserted as "shall" (error) and "should" (warning). |
| ElementDefinition.constraint.human | Human description of constraint | Text that can be used to describe the constraint in messages identifying that the constraint has been violated. | Should be expressed in business terms as much as possible. |
| ElementDefinition.constraint.expression | FHIRPath expression of constraint | A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met. | In the absense of an expression, the expression is likely not enforceable by validators, and might be missed by many systems. |
| ElementDefinition.constraint.xpath | XPath expression of constraint | An XPath expression of constraint that can be executed to see if this constraint is met. | Elements SHALL use "f" as the namespace prefix for the FHIR namespace, and "x" for the xhtml namespace, and SHALL NOT use any other prefixes. Note: XPath is generally considered not useful because it does not apply to JSON and other formats and because of XSLT implementation issues, and may be removed in the future. |
| ElementDefinition.constraint.source | Reference to original source of constraint | A reference to the original source of the constraint, for traceability purposes. | This is used when, e.g. rendering, where it is not useful to present inherited constraints when rendering the snapshot. |
| ElementDefinition.mustSupport | If the element must be supported | If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation. | "Something useful" is context dependent and impossible to describe in the base FHIR specification. For this reason, tue mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. A profile on a type can always make musSupport = 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. |
| ElementDefinition.isModifier | If this modifies the meaning of other elements | 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. | Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear. |
| ElementDefinition.isModifierReason | Reason that this element is marked as a modifier | Explains how that element affects the interpretation of the resource or element that contains it. | |
| ElementDefinition.isSummary | Include when _summary = true? | Whether the element should be included if a client requests a search with the parameter _summary=true. | Some resources include a set of simple metadata, and some very large data. This element is used to reduce the quantity of data returned in searches. Note that servers may pre-cache summarized resources for optimal performance, so servers might not support per-profile use of the isSummary flag. When a request is made with _summary=true, serailisers only include elements marked as 'isSummary = true'. Other than Attachment.data, all data type properties are included in the summary form. In resource and data type definitions, if an element is at the root or has a parent that is 'mustSupport' and the minimum cardinality is 1 or the element is a modifier, it must be marked as isSummary=true. |
| ElementDefinition.binding | ValueSet details if this is coded | Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri). | 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. |
| ElementDefinition.binding.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.binding.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.binding.strength | required | extensible | preferred | example | 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. | For further discussion, see [Using Terminologies](terminologies.html). |
| ElementDefinition.binding.description | Human explanation of the value set | Describes the intended use of this particular set of codes. | |
| ElementDefinition.binding.valueSet | Source of value set | Refers to the value set that identifies the set of codes the binding refers to. | The reference may be version-specific or not (e.g. have a |[version] at the end of the canonical URL). |
| ElementDefinition.mapping | Map element to another set of definitions | Identifies a concept from an external specification that roughly corresponds to this element. | Mappings are not necessarily specific enough for safe translation. |
| ElementDefinition.mapping.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ElementDefinition.mapping.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ElementDefinition.mapping.identity | Reference to mapping declaration | An internal reference to the definition of a mapping. | |
| ElementDefinition.mapping.language | Computable language of mapping | Identifies the computable language in which mapping.map is expressed. | If omitted, then there can be no expectation of computational interpretation of the mapping. |
| ElementDefinition.mapping.map | Details of the mapping | Expresses what part of the target specification corresponds to this element. | 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. |
| ElementDefinition.mapping.comment | Comments about the mapping or its use | Comments that provide information about the mapping or its use. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Expression | An expression that can be used to generate a value | 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. | |
| Expression.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Expression.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Expression.description | Natural language description of the condition | A brief, natural language description of the condition that effectively communicates the intended semantics. | |
| Expression.name | Short name assigned to expression for reuse | A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined. | |
| Expression.language | text/cql | text/fhirpath | application/x-fhir-query | etc. | The media type of the language for the expression. | |
| Expression.expression | Expression in specified language | An expression in the specified language that returns a value. | |
| Expression.reference | Where the expression is found | A URI that defines where the expression is found. | If both a reference and an expression is found, the reference SHALL point to the same expression. |
Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Extension | Optional Extensions Element | Optional Extension Element - found in all resources. | |
| Extension.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Extension.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Extension.url | identifies the meaning of the extension | Source of the definition for the extension code - a logical name or a URL. | 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. |
| Extension.value[x] | Value of extension | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Base StructureDefinition for HumanName Type: A human's name with the ability to identify parts and usage.
| Path | Short | Definition | Comments |
|---|---|---|---|
| HumanName | Name of a human - parts and usage | A human's name with the ability to identify parts and usage. | 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. |
| HumanName.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| HumanName.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| HumanName.use | usual | official | temp | nickname | anonymous | old | maiden | Identifies the purpose for this name. | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| HumanName.text | Text representation of the full name | 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. | 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. |
| HumanName.family | Family name (often called 'Surname') | 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). |
| HumanName.given | Given names (not always 'first'). Includes middle names | 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. |
| HumanName.prefix | Parts that come before 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 start of the name. | |
| HumanName.suffix | Parts that come after 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. | |
| HumanName.period | Time period when name was/is in use | Indicates the period of time when this name was valid for the named person. |
Base StructureDefinition for Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Identifier | An identifier intended for computation | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | |
| Identifier.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Identifier.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Identifier.use | usual | official | temp | secondary | old (If known) | The purpose of this identifier. | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Identifier.type | Description of identifier | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | 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. |
| Identifier.system | The namespace for the identifier value | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | Identifier.system is always case sensitive. |
| Identifier.value | The value that is unique | 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 [Rendered Value extension](extension-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. |
| Identifier.period | Time period when id is/was valid for use | Time period during which identifier is/was valid for use. | |
| Identifier.assigner | Organization that issued id (may be just text) | 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. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| MarketingStatus | 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 | 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. | |
| MarketingStatus.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| MarketingStatus.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| MarketingStatus.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| MarketingStatus.country | The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements | The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements. | |
| MarketingStatus.jurisdiction | Where a Medicines Regulatory Agency has granted a marketing authorisation 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 | Where a Medicines Regulatory Agency has granted a marketing authorisation 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. | |
| MarketingStatus.status | This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples | This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples. | |
| MarketingStatus.dateRange | The date when the Medicinal Product is placed on the market by the Marketing Authorisation 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 | The date when the Medicinal Product is placed on the market by the Marketing Authorisation 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. | |
| MarketingStatus.restoreDate | The date when the Medicinal Product is placed on the market by the Marketing Authorisation 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 | The date when the Medicinal Product is placed on the market by the Marketing Authorisation 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. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Meta | Metadata about a resource | 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. | |
| Meta.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Meta.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Meta.versionId | Version specific identifier | 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. | 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. |
| Meta.lastUpdated | When the resource version last changed | When the resource last changed - e.g. when the version changed. | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction. |
| Meta.source | Identifies where the resource comes from | 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. | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This 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. |
| Meta.profile | Profiles this resource claims to conform to | 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). | 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. |
| Meta.security | Security Labels applied to this resource | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | 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. |
| Meta.tag | Tags applied to this resource | 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. | 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. |
Base StructureDefinition for Money Type: An amount of economic utility in some recognized currency.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Money | An amount of economic utility in some recognized currency | An amount of economic utility in some recognized currency. | |
| Money.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Money.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Money.value | Numerical value (with implicit precision) | Numerical value (with implicit precision). | Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Money.currency | ISO 4217 Currency Code | ISO 4217 Currency Code. |
Base StructureDefinition for Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Narrative | Human-readable summary of the resource (essential clinical and business information) | A human-readable summary of the resource conveying the essential clinical and business information for the resource. | |
| Narrative.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Narrative.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Narrative.status | generated | extensions | additional | empty | 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. | |
| Narrative.div | Limited xhtml content | The actual narrative content, a stripped down version of XHTML. | 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. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| ParameterDefinition | Definition of a parameter to a module | 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. | |
| ParameterDefinition.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ParameterDefinition.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ParameterDefinition.name | Name used to access the parameter value | The name of the parameter used to allow access to the value of the parameter in evaluation contexts. | |
| ParameterDefinition.use | in | out | Whether the parameter is input or output for the module. | |
| ParameterDefinition.min | Minimum cardinality | The minimum number of times this parameter SHALL appear in the request or response. | |
| ParameterDefinition.max | Maximum cardinality (a number of *) | The maximum number of times this element is permitted to appear in the request or response. | |
| ParameterDefinition.documentation | A brief description of the parameter | A brief discussion of what the parameter is for and how it is used by the module. | |
| ParameterDefinition.type | What type of value | The type of the parameter. | |
| ParameterDefinition.profile | What profile the value is expected to be | If specified, this indicates a profile that the input data must conform to, or that the output data will conform to. |
Base StructureDefinition for Period Type: A time period defined by a start and end date and optionally time.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Period | Time range defined by start and end date/time | 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](datatypes.html#Duration). |
| Period.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Period.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Period.start | Starting time with inclusive boundary | 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. |
| Period.end | End time with inclusive boundary, if not ongoing | 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 high 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. |
Base StructureDefinition for Population Type: A populatioof people with some set of grouping criteria.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Population | A definition of a set of people that apply to some clinically related context, for example people contraindicated for a certain medication | A populatioof people with some set of grouping criteria. | |
| Population.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Population.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Population.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| Population.age[x] | The age of the specific population | The age of the specific population. | |
| Population.gender | The gender of the specific population | The gender of the specific population. | |
| Population.race | Race of the specific population | Race of the specific population. | |
| Population.physiologicalCondition | The existing physiological conditions of the specific population to which this applies | The existing physiological conditions of the specific population to which this applies. |
Base StructureDefinition for ProdCharacteristic 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| ProdCharacteristic | 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 | 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. | |
| ProdCharacteristic.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ProdCharacteristic.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ProdCharacteristic.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| ProdCharacteristic.height | Where applicable, the height can be specified using a numerical value and its unit of 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 | Where applicable, the height can be specified using a numerical value and its unit of 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. | |
| ProdCharacteristic.width | Where applicable, the width can be specified using a numerical value and its unit of 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 | Where applicable, the width can be specified using a numerical value and its unit of 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. | |
| ProdCharacteristic.depth | Where applicable, the depth can be specified using a numerical value and its unit of 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 | Where applicable, the depth can be specified using a numerical value and its unit of 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. | |
| ProdCharacteristic.weight | Where applicable, the weight can be specified using a numerical value and its unit of 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 | Where applicable, the weight can be specified using a numerical value and its unit of 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. | |
| ProdCharacteristic.nominalVolume | Where applicable, the nominal volume can be specified using a numerical value and its unit of 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 | Where applicable, the nominal volume can be specified using a numerical value and its unit of 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. | |
| ProdCharacteristic.externalDiameter | Where applicable, the external diameter can be specified using a numerical value and its unit of 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 | Where applicable, the external diameter can be specified using a numerical value and its unit of 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. | |
| ProdCharacteristic.shape | Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used | Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used. | |
| ProdCharacteristic.color | Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used | Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used. | |
| ProdCharacteristic.imprint | Where applicable, the imprint can be specified as text | Where applicable, the imprint can be specified as text. | |
| ProdCharacteristic.image | Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations | Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations. | |
| ProdCharacteristic.scoring | Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used | Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used. |
Base StructureDefinition for ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.
| Path | Short | Definition | Comments |
|---|---|---|---|
| ProductShelfLife | The shelf-life and storage information for a medicinal product item or container can be described using this class | The shelf-life and storage information for a medicinal product item or container can be described using this class. | |
| ProductShelfLife.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| ProductShelfLife.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| ProductShelfLife.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| ProductShelfLife.identifier | Unique identifier for the packaged Medicinal Product | Unique identifier for the packaged Medicinal Product. | |
| ProductShelfLife.type | 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 | 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. | |
| ProductShelfLife.period | 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 | 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. | |
| ProductShelfLife.specialPrecautionsForStorage | 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 | 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. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Quantity | A measured or measurable amount | 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. | 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. |
| Quantity.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Quantity.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Quantity.value | Numerical value (with implicit precision) | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | 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). |
| Quantity.comparator | < | <= | >= | > - how to understand the value | 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. | |
| Quantity.unit | Unit representation | A human-readable form of the unit. | |
| Quantity.system | System that defines coded unit form | The identification of the system that provides the coded form of the unit. | |
| Quantity.code | Coded form of the unit | A computer processable form of the unit in some unit representation system. | 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. |
Base StructureDefinition for Range Type: A set of ordered Quantities defined by a low and high limit.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Range | Set of values bounded by low and high | A set of ordered Quantities defined by a low and high limit. | 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. |
| Range.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Range.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Range.low | Low limit | The low limit. The boundary is inclusive. | If the low element is missing, the low boundary is not known. |
| Range.high | High limit | The high limit. The boundary is inclusive. | If the high element is missing, the high boundary is not known. |
Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Ratio | A ratio of two Quantity values - a numerator and a denominator | A relationship of two Quantity values - expressed as a numerator and a denominator. | 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. |
| Ratio.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Ratio.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Ratio.numerator | Numerator value | The value of the numerator. | |
| Ratio.denominator | Denominator value | The value of the denominator. |
Base StructureDefinition for Reference Type: A reference from one resource to another.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Reference | A reference from one resource to another | A reference from one resource to another. | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Reference.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Reference.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Reference.reference | Literal reference, Relative, internal or absolute URL | 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. | 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. |
| Reference.type | Type the reference refers to (e.g. "Patient") | 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. The 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). | 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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
| Reference.identifier | Logical reference, when literal reference is not known | 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. | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference 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). |
| Reference.display | Text alternative for the resource | Plain text narrative that identifies the resource in addition to the resource reference. | 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. |
Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.
| Path | Short | Definition | Comments |
|---|---|---|---|
| RelatedArtifact | Related artifacts for a knowledge resource | Related artifacts such as additional documentation, justification, or bibliographic references. | Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. |
| RelatedArtifact.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| RelatedArtifact.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| RelatedArtifact.type | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | The type of relationship to the related artifact. | |
| RelatedArtifact.label | Short label | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. | |
| RelatedArtifact.display | Brief description of the related artifact | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. | |
| RelatedArtifact.citation | Bibliographic citation for the artifact | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. | Additional structured information about citations should be captured as extensions. |
| RelatedArtifact.url | Where the artifact can be accessed | A url for the artifact that can be followed to access the actual content. | If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference). |
| RelatedArtifact.document | What document is being referenced | The document being referenced, represented as an attachment. This is exclusive with the resource element. | |
| RelatedArtifact.resource | What resource is being referenced | The related resource, such as a library, value set, profile, or other knowledge resource. | 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. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| SampledData | A series of measurements taken by a device | A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data. | 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". |
| SampledData.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| SampledData.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| SampledData.origin | Zero value and units | The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series. | |
| SampledData.period | Number of milliseconds between samples | The length of time between sampling times, measured in milliseconds. | This is usually a whole number. |
| SampledData.factor | Multiply data by this before adding to origin | A correction factor that is applied to the sampled data points before they are added to the origin. | |
| SampledData.lowerLimit | Lower limit of detection | 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). | |
| SampledData.upperLimit | Upper limit of detection | 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). | |
| SampledData.dimensions | Number of sample points at each time point | 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). |
| SampledData.data | Decimal values with spaces, or "E" | "U" | "L" | A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value. | Data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Signature | A Signature - XML DigSig, JWS, Graphical image of signature, etc. | 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. | 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. |
| Signature.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Signature.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Signature.type | Indication of the reason the entity signed the object(s) | 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 "Commitment Type Indication". |
| Signature.when | When the signature was created | When the digital signature was signed. | This should agree with the information in the signature. |
| Signature.who | Who signed | 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. |
| Signature.onBehalfOf | The party represented | A reference to an application-usable description of the identity that is represented by the signature. | The party that can't sign. For example a child. |
| Signature.targetFormat | The technical format of the signed resources | 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. |
| Signature.sigFormat | The technical format of the signature | 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. | |
| Signature.data | The actual signature content (XML DigSig. JWS, picture, 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. |
Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.
| Path | Short | Definition | Comments |
|---|---|---|---|
| SubstanceAmount | Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID | Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID. | |
| SubstanceAmount.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| SubstanceAmount.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| SubstanceAmount.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| SubstanceAmount.amount[x] | Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field | Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field. | |
| SubstanceAmount.amountType | Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements | Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements. | |
| SubstanceAmount.amountText | A textual comment on a numeric value | A textual comment on a numeric value. | |
| SubstanceAmount.referenceRange | Reference range of possible or expected values | Reference range of possible or expected values. | |
| SubstanceAmount.referenceRange.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| SubstanceAmount.referenceRange.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| SubstanceAmount.referenceRange.lowLimit | Lower limit possible or expected | Lower limit possible or expected. | |
| SubstanceAmount.referenceRange.highLimit | Upper limit possible or expected | Upper limit possible or expected. |
Base StructureDefinition for 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.
| Path | Short | Definition | Comments |
|---|---|---|---|
| Timing | A timing schedule that specifies an event that may occur multiple times | 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. | 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. |
| Timing.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Timing.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Timing.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | 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. |
| Timing.event | When the event occurs | Identifies specific times when the event occurs. | |
| Timing.repeat | When the event is to occur | A set of rules that describe when the event is scheduled. | |
| Timing.repeat.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Timing.repeat.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Timing.repeat.bounds[x] | Length/Range of lengths, or (Start and/or end) limits | 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. | |
| Timing.repeat.count | Number of times to repeat | 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. | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
| Timing.repeat.countMax | Maximum number of times to repeat | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. | |
| Timing.repeat.duration | How long when it happens | 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. | 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). |
| Timing.repeat.durationMax | How long when it happens (Max) | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. | 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). |
| Timing.repeat.durationUnit | s | min | h | d | wk | mo | a - unit of time (UCUM) | The units of time for the duration, in UCUM units. | |
| Timing.repeat.frequency | Event occurs frequency times per period | 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. | |
| Timing.repeat.frequencyMax | Event occurs up to frequencyMax times per period | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. | |
| Timing.repeat.period | Event occurs frequency times per period | 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. | |
| Timing.repeat.periodMax | Upper limit of period (3-4 hours) | 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. | |
| Timing.repeat.periodUnit | s | min | h | d | wk | mo | a - unit of time (UCUM) | The units of time for the period in UCUM units. | |
| Timing.repeat.dayOfWeek | mon | tue | wed | thu | fri | sat | sun | 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. The elements frequency and period cannot be used as well as dayOfWeek. |
| Timing.repeat.timeOfDay | Time of day for action | 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. The elements when, frequency and period cannot be used as well as timeOfDay. |
| Timing.repeat.when | Code for time period of occurrence | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. | When more than one event is listed, the event is tied to the union of the specified events. |
| Timing.repeat.offset | Minutes from event (before or after) | 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. | |
| Timing.code | BID | TID | QID | AM | PM | QD | QOD | + | 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). |
Base StructureDefinition for TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
| Path | Short | Definition | Comments |
|---|---|---|---|
| TriggerDefinition | Defines an expected trigger for a module | A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element. | 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. |
| TriggerDefinition.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| TriggerDefinition.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| TriggerDefinition.type | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended | The type of triggering event. | |
| TriggerDefinition.name | Name or URI that identifies the event | 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. | 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. |
| TriggerDefinition.timing[x] | Timing of the event | The timing of the event (if this is a periodic trigger). | |
| TriggerDefinition.data | Triggering data of the event (multiple = 'and') | 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. | This element shall be present for any data type trigger. |
| TriggerDefinition.condition | Whether the event triggers (boolean expression) | 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. | 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. |
Base StructureDefinition for 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).
| Path | Short | Definition | Comments |
|---|---|---|---|
| UsageContext | Describes the context of use for a conformance or knowledge resource | 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). | |
| UsageContext.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| UsageContext.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| UsageContext.code | Type of context being specified | A code that identifies the type of context being specified by this usage context. | |
| UsageContext.value[x] | Value that defines the context | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision)
| Path | Short | Definition | Comments |
|---|---|---|---|
| Quantity | An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision) | 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). | 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. |
| Quantity.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Quantity.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Quantity.value | Numerical value (with implicit precision) | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | 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). |
| Quantity.comparator | < | <= | >= | > - how to understand the value | 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. | |
| Quantity.unit | Unit representation | A human-readable form of the unit. | |
| Quantity.system | System that defines coded unit form | The identification of the system that provides the coded form of the unit. | |
| Quantity.code | Coded form of the unit | A computer processable form of the unit in some unit representation system. | 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. |
A fixed quantity (no comparator)
| Path | Short | Definition | Comments |
|---|---|---|---|
| Quantity | A fixed quantity (no comparator) | The comparator is not used on a SimpleQuantity | 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. |
| Quantity.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Quantity.extension | Additional content defined by implementations | 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 manageable, 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. | 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. |
| Quantity.value | Numerical value (with implicit precision) | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | 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). |
| Quantity.comparator | < | <= | >= | > - how to understand the value | Not allowed to be used in this context | |
| Quantity.unit | Unit representation | A human-readable form of the unit. | |
| Quantity.system | System that defines coded unit form | The identification of the system that provides the coded form of the unit. | |
| Quantity.code | Coded form of the unit | A computer processable form of the unit in some unit representation system. | 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. |