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.
If the element is present, it must have either a @value, an @id, or extensions
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.
If the element is present, it must have either a @value, an @id, or extensions
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
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
A sequence of Unicode characters
Note that FHIR strings SHALL NOT exceed 1MB in size
If the element is present, it must have either a @value, an @id, or extensions
A whole number
32 bit number; for values larger than this, use decimal
If the element is present, it must have either a @value, an @id, or extensions
An OID represented as a URI
RFC 3001. See also ISO/IEC 8824:1990 €
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
A URI that is a reference to a canonical URL on a FHIR resource
see [Canonical References](references.html#canonical)
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
String of characters used to identify a name or a resource
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
If the element is present, it must have either a @value, an @id, or extensions
A UUID, represented as a URI
See The Open Group, CDE 1.1 Remote Procedure Call specification, Appendix A.
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
A URI that is a literal reference
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
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
If the element is present, it must have either a @value, an @id, or extensions
Value of "true" or "false"
If the element is present, it must have either a @value, an @id, or extensions
A stream of bytes
A stream of bytes, base64 encoded
If the element is present, it must have either a @value, an @id, or extensions
An integer with a value that is not negative (e.g. >= 0)
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
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/
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
A time during the day, with no date specified
If the element is present, it must have either a @value, an @id, or extensions
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
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
An integer with a value that is positive (e.g. >0)
If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions
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)
If the element is present, it must have either a @value, an @id, or extensions
Optional Extension Element - found in all resources.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Base definition for all elements that are defined inside a resource - but not those in a data type.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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).
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
The actual narrative content, a stripped down version of XHTML.
Generated
Extensions
Additional
Empty
The status of a resource narrative.
If the element is present, it must have either a @value, an @id, or extensions
Base definition for all elements in a resource.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
When the resource last changed - e.g. when the version changed.
A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] 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.
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
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.
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The purpose of this address.
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
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.
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
The name of the city, town, suburb, village or other community or delivery center.
The name of the administrative area (county).
Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
A postal code designating a region defined by the postal service.
Country - a nation as commonly understood or generally accepted.
Time period when address was/is in use.
Home
Work
Temporary
Old / Incorrect
Billing
The use of an address.
If the element is present, it must have either a @value, an @id, or extensions
Postal
Physical
Postal & Physical
The type of an address (physical / postal).
If the element is present, it must have either a @value, an @id, or extensions
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The type of contributor.
The name of the individual or organization responsible for the contribution.
Contact details to assist a user in finding and communicating with the contributor.
Author
Editor
Reviewer
Endorser
The type of contributor.
If the element is present, it must have either a @value, an @id, or extensions
For referring to data content defined in other formats.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
The human language of the content. The value can be any valid value according to BCP 47.
The actual data of the attachment - a sequence of bytes, base64 encoded.
A location where the data can be accessed.
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
The calculated hash of the data using SHA-1. Represented using base64.
A label or set of text to display in place of the data.
The date that the attachment was first created.
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
The profile of the required data, specified as the uri of the profile definition.
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
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).
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.
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.
Specifies a maximum number of results that are required (uses the _count search parameter).
Specifies the order of the results to be returned.
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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.
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.
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.
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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.
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.
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
The direction of the sort, ascending or descending.
Ascending
Descending
The possible sort directions, ascending or descending.
If the element is present, it must have either a @value, an @id, or extensions
Indicates how the medication is/was taken or should be taken by the patient.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Indicates the order in which the dosage instructions should be applied or interpreted.
Free text dosage instructions e.g. SIG.
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").
Instructions in terms that are understood by the patient or consumer.
When medication should be administered.
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).
Body site to administer to.
How drug should enter body.
Technique for administering medication.
The amount of medication administered.
Upper limit on medication per unit of time.
Upper limit on medication per administration.
Upper limit on medication per lifetime of the patient.
Indicates how the medication is/was taken or should be taken by the patient.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The kind of dose or rate specified, for example, ordered or calculated.
Amount of medication per dose.
Amount of medication per unit of time.
An amount of economic utility in some recognized currency.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Numerical value (with implicit precision).
ISO 4217 Currency Code.
A human's name with the ability to identify parts and usage.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Identifies the purpose for this 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.
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.
Given 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.
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Indicates the period of time when this name was valid for the named person.
Usual
Official
Temp
Nickname
Anonymous
Old
Name changed for Marriage
The use of a human name.
If the element is present, it must have either a @value, an @id, or extensions
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Telecommunications form for contact point - what communications system is required to make use of the contact.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Identifies the purpose for the contact point.
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.
Time period when the contact point was/is in use.
Phone
Fax
Email
Pager
URL
SMS
Other
Telecommunications form for contact point.
If the element is present, it must have either a @value, an @id, or extensions
Home
Work
Temp
Old
Mobile
Use of contact point.
If the element is present, it must have either a @value, an @id, or extensions
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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.
This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.
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.
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The purpose of this identifier.
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Time period during which identifier is/was valid for use.
Organization that issued/manages the identifier.
Usual
Official
Temp
Secondary
Old
Identifies the purpose for this identifier, if known .
If the element is present, it must have either a @value, an @id, or extensions
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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.
A textual comment on a numeric value.
Reference range of possible or expected values.
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Lower limit possible or expected.
Upper limit possible or expected.
A reference to a code defined by a terminology system.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The identification of the code system that defines the meaning of the symbol in the code.
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.
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).
A representation of the meaning of the code in the system, following the rules of the system.
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.
The length of time between sampling times, measured in milliseconds.
A correction factor that is applied to the sampled data points before they are added to the origin.
The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).
The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).
The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.
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.
A populatioof people with some set of grouping criteria.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The age of the specific population.
The gender of the specific population.
Race of the specific population.
The existing physiological conditions of the specific population to which this applies.
A relationship of two Quantity values - expressed as a numerator and a denominator.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The value of the numerator.
The value of the denominator.
A length - a value with a unit that is a physical distance.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
A duration of time during which an organism (or a process) has existed.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
A reference from one resource to another.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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).
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.
Plain text narrative that identifies the resource in addition to the resource reference.
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The type of triggering 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.
The timing of the event (if this is a periodic trigger).
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.
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.
Named Event
Periodic
Data Changed
Data Added
Data Updated
Data Removed
Data Accessed
Data Access Ended
The type of trigger.
If the element is present, it must have either a @value, an @id, or extensions
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The value of the measured amount. The value includes an implicit precision in the presentation of 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.
A human-readable form of the unit.
The identification of the system that provides the coded form of the unit.
A computer processable form of the unit in some unit representation system.
Less than
Less or Equal to
Greater or Equal to
Greater than
How the Quantity should be understood and represented.
If the element is present, it must have either a @value, an @id, or extensions
A time period defined by a start and end date and optionally time.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The start of the period. The boundary is inclusive.
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.
A length of time.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
A set of ordered Quantities defined by a low and high limit.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The low limit. The boundary is inclusive.
The high limit. The boundary is inclusive.
Related artifacts such as additional documentation, justification, or bibliographic references.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The type of relationship to the related artifact.
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
A url for the artifact that can be followed to access the actual content.
The document being referenced, represented as an attachment. This is exclusive with the resource element.
The related resource, such as a library, value set, profile, or other knowledge resource.
Documentation
Justification
Citation
Predecessor
Successor
Derived From
Depends On
Composed Of
The type of relationship to the related artifact.
If the element is present, it must have either a @value, an @id, or extensions
A text note which also contains information about who made the statement and when.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The individual responsible for making the annotation.
Indicates when this particular annotation was made.
The text of the annotation in markdown format.
The shelf-life and storage information for a medicinal product item or container can be described using this class.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Unique identifier for the packaged Medicinal Product.
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.
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.
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.
Specifies contact information for a person or organization.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The name of an individual to contact.
The contact details for the individual (if a name was provided) or the organization.
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).
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
A code that identifies the type of context being specified by this usage context.
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
A brief, natural language description of the condition that effectively communicates the intended semantics.
A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
The media type of the language for the expression.
An expression in the specified language that returns a value.
A URI that defines where the expression is found.
CQL
FHIRPath
FHIR Query
The media type of the expression language.
If the element is present, it must have either a @value, an @id, or extensions
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
When the digital signature was signed.
A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
A reference to an application-usable description of the identity that is represented by the signature.
A mime type that indicates the technical format of the target resources signed by 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.
The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Identifies specific times when the event occurs.
A set of rules that describe when the event is scheduled.
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).
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
The units of time for the duration, in UCUM units.
The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
The units of time for the period in UCUM units.
If one or more days of week is provided, then the action happens only on the specified day(s).
Specified time of day for action to take place.
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
秒
分钟
小时
天
星期
月
年
A unit of time (units from UCUM).
If the element is present, it must have either a @value, an @id, or extensions
Morning
Early Morning
Late Morning
Noon
Afternoon
Early Afternoon
Late Afternoon
Evening
Early Evening
Late Evening
Night
After Sleep
HS
WAKE
C
CM
CD
CV
AC
ACM
ACD
ACV
PC
PCM
PCD
PCV
Real world event relating to the schedule.
If the element is present, it must have either a @value, an @id, or extensions
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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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 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 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 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 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 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 shape 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.
Where applicable, the imprint can be specified as text.
Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.
Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
A reference to a code defined by a terminology system.
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
The 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.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
Whether the parameter is input or output for the module.
The minimum number of times this parameter SHALL appear in the request or response.
The maximum number of times this element is permitted to appear in the request or response.
A brief discussion of what the parameter is for and how it is used by the module.
The type of the parameter.
If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.
Codes that define how this element is represented in instances, when the deviation varies from the normal case.
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.
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.
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.
A code that has the same meaning as the element in a particular terminology.
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).
A concise description of what this element means (e.g. for use in autogenerated summaries).
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).
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).
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.
Identifies additional names by which this element might also be known.
The minimum number of times this element SHALL appear in the instance.
The maximum number of times this element is permitted to appear in the instance.
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.
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.
The data type or resource that the value of this element is permitted to be.
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').
The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').
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.
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.
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.
A sample value for this element demonstrating the type of information that would typically be found in the element.
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.
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.
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.
A reference to an invariant that may make additional statements about the cardinality or value in the instance.
Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
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.
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.
Explains how that element affects the interpretation of the resource or element that contains it.
Whether the element should be included if a client requests a search with the parameter _summary=true.
Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
Identifies a concept from an external specification that roughly corresponds to this element.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
Description of why this constraint is necessary or appropriate.
Identifies the impact constraint violation has on the conformance of the instance.
Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.
An XPath expression of constraint that can be executed to see if this constraint is met.
A reference to the original source of the constraint, for traceability purposes.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
An internal reference to the definition of a mapping.
Identifies the computable language in which mapping.map is expressed.
Expresses what part of the target specification corresponds to this element.
Comments that provide information about the mapping or its use.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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]]] without a StructureDefinition.base.
Minimum cardinality of the base element identified by the path.
Maximum cardinality of the base element identified by the path.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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.
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.
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.
Whether this reference needs to be version specific or version independent, or whether either can be used.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
Describes the purpose of this example amoung the set of examples.
The actual value for the element, which must be one of the types allowed for this element.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
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 the matching elements have to occur in the same order as defined in the profile.
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.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
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.
Describes the intended use of this particular set of codes.
Refers to the value set that identifies the set of codes the binding refers to.
Captures constraints on each element within the resource, profile, or extension.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
How the element value is interpreted when discrimination is evaluated.
A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.
XML Attribute
XML Text
Type Attribute
CDA Text Format
XHTML
How a property is represented when serialized.
If the element is present, it must have either a @value, an @id, or extensions
Error
Warning
SHALL applications comply with this constraint?
If the element is present, it must have either a @value, an @id, or extensions
Contained
Referenced
Bundled
How resource references can be aggregated.
If the element is present, it must have either a @value, an @id, or extensions
Either Specific or independent
Version independent
Version Specific
Whether a reference needs to be version specific or version independent, or whether either can be used.
If the element is present, it must have either a @value, an @id, or extensions
Closed
Open
Open at End
How slices are interpreted when evaluating an instance.
If the element is present, it must have either a @value, an @id, or extensions
Required
Extensible
Preferred
Example
Indication of the degree of conformance expectations associated with a binding.
If the element is present, it must have either a @value, an @id, or extensions
Value
Exists
Pattern
Type
Profile
How an element value is interpreted when discrimination is evaluated.
If the element is present, it must have either a @value, an @id, or extensions
A resource that includes narrative, extensions, and contained resources.
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
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.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
This is the base resource type for everything.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
The base language in which the resource is written.
Draft
черновик
ontwerp
Active
активный
actief
Retired
удалён
verouderd
Unknown
If the element is present, it must have either a @value, an @id, or extensions
Number
Date/DateTime
String
Token
Reference
Composite
Quantity
URI
Special
If the element is present, it must have either a @value, an @id, or extensions
Male
Female
Other
Unknown
If the element is present, it must have either a @value, an @id, or extensions
0.01
0.05
0.06
0.11
0.0.80
0.0.81
0.0.82
0.4.0
0.5.0
1.0.0
1.0.1
1.0.2
1.1.0
1.4.0
1.6.0
1.8.0
3.0.0
3.0.1
3.3.0
3.5.0
4.0.0
4.0.1
If the element is present, it must have either a @value, an @id, or extensions
Display
Print (Form)
Print (Operator)
If the element is present, it must have either a @value, an @id, or extensions
Queued
Processing Complete
Error
Partial Processing
If the element is present, it must have either a @value, an @id, or extensions
Related To
Equivalent
Equal
Wider
Subsumes
Narrower
Specializes
Inexact
Unmatched
Disjoint
If the element is present, it must have either a @value, an @id, or extensions
Current
Superseded
Entered in Error
If the element is present, it must have either a @value, an @id, or extensions